Skip to content

Commit

Permalink
Update Quick Start.md
Browse files Browse the repository at this point in the history
Signed-off-by: Josh XT <[email protected]>
  • Loading branch information
Josh-XT authored Jul 5, 2023
1 parent c70749d commit 809e319
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/1-Getting started/Quick Start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ Note: If you run locally without docker, it is unsupported. Any issues you enco
Open a terminal and run the following commands to download the docker-compose file and the example environment file:

```
mkdir AGiXT
git clone https://github.com/Josh-XT/AGiXT
cd AGiXT
wget https://raw.githubusercontent.com/Josh-XT/AGiXT/main/docker-compose.yml
wget https://raw.githubusercontent.com/Josh-XT/AGiXT/main/.env.example
```

### Editing the environment file
Expand All @@ -29,7 +27,7 @@ Open the `.env.example` file in a text editor, you will want to at least change
- `GITHUB_TOKEN` is your GitHub personal access token, this is only required if using your own AGiXT hub to pull your repository data.

### Running AGiXT
Once you have edited the `.env.example` file, save it and run the following command to start AGiXT:
Once you have edited the `.env.example` file, save it as `.env` and run the following command to start AGiXT:
```
docker-compose up -d
```
Expand All @@ -45,4 +43,4 @@ To update AGiXT, run the following commands from your `AGiXT` directory:
docker-compose down
docker-compose pull
docker-compose up -d
```
```

0 comments on commit 809e319

Please sign in to comment.