add prerequisites section

janhq · Jun 26, 2024 · 8bb43cd · 8bb43cd
1 parent 8ccc304
commit 8bb43cd
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git 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
@@ -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