Skip to content

Commit 6ddf2aa

Browse files
Update README.md
1 parent 8ff4250 commit 6ddf2aa

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ the directions listed below.
77
# Pre-requistites
88
- A Cortex instance.
99
- The Command prompt (on a Mac: Finder -> Applications -> Utilities -> Terminal)
10+
- a folder on your computer to clone the learn-cortex repository to
1011
- [Homebrew](https://brew.sh/) installed
1112

1213
**TL;DR**
@@ -16,13 +17,59 @@ the directions listed below.
1617
which brew > /dev/null || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
1718
```
1819
20+
1921
# Installation
20-
This repository uses [just](https://github.com/casey/just) to run the set up tasks.
22+
- If needed, create a folder on your computer to store repositories (such as ~/Repos)
23+
24+
```
25+
mkdir ~/Repos
26+
```
27+
- Install git
28+
29+
```
30+
brew install git
31+
```
32+
33+
- Navigate to your repository folder, and clone the learn-cortex repository
34+
35+
```
36+
cd ~/Repos
37+
git clone https://github.com/cortexapps/learn-cortex.git
38+
```
39+
40+
- This repository uses [just](https://github.com/casey/just) to run the set up tasks
41+
42+
```
43+
brew install just
44+
```
45+
46+
- install the cortex CLI (required to setup Justfile)
47+
48+
```
49+
brew tap cortexapps/tap
50+
brew install cortexapps-cli
51+
```
52+
53+
- Create a Cortex personal token following the steps in https://docs.cortex.io/docs/walkthroughs/workspace-settings/personal-tokens, and then set environment variable CORTEX_API_KEY with the token value
54+
55+
```
56+
export CORTEX_API_KEY=<your personal token>
57+
```
58+
59+
- set environment variable CORTEX_EMAIL with email that will be used as the owner of the Learn Cortex entity
60+
61+
```
62+
63+
```
64+
65+
- Navigate to the newly-cloned learn-cortex folder and run just setup
66+
67+
```
68+
cd learn-cortex
69+
just setup
70+
```
71+
2172
22-
```
23-
brew install just
24-
just setup
25-
```
2673
2774
# The Learn Cortex entity
2875
You will now have an entity named Learn Cortex in your catalog.

0 commit comments

Comments
 (0)