From 8bb43cdf651f8d28ea89e6f46c78da342cb383e7 Mon Sep 17 00:00:00 2001 From: irfanpena Date: Wed, 26 Jun 2024 11:16:18 +0700 Subject: [PATCH] add prerequisites section --- README.md | 14 ++++++++++++-- cortex-js/README.md | 14 ++++++++++++-- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 668f9d589..f663547b6 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,18 @@ Cortex currently supports 3 inference engines: - [Docs](https://cortex.jan.ai/docs/) ## Quickstart - -Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. +### Prerequisites +Ensure that your system meets the following requirements to run Cortex: +- **Dependencies**: + - **Node.js**: version 18 and above is required to run the installation. + - **NPM**: Needed to manage packages. + - **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page. +- **OS**: + - MacOSX 13.6 or higher. + - Windows 10 or higher. + - Ubuntu 12.04 and later. + +> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. ``` bash npm i -g cortexso diff --git a/cortex-js/README.md b/cortex-js/README.md index 668f9d589..f663547b6 100644 --- a/cortex-js/README.md +++ b/cortex-js/README.md @@ -25,8 +25,18 @@ Cortex currently supports 3 inference engines: - [Docs](https://cortex.jan.ai/docs/) ## Quickstart - -Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. +### Prerequisites +Ensure that your system meets the following requirements to run Cortex: +- **Dependencies**: + - **Node.js**: version 18 and above is required to run the installation. + - **NPM**: Needed to manage packages. + - **CPU Instruction Sets**: Available for download from the [Cortex GitHub Releases](https://github.com/janhq/cortex/releases) page. +- **OS**: + - MacOSX 13.6 or higher. + - Windows 10 or higher. + - Ubuntu 12.04 and later. + +> Visit [Quickstart](https://cortex.jan.ai/docs/quickstart) to get started. ``` bash npm i -g cortexso