Skip to content

Commit

Permalink
docs: update readme to point towards yarn local
Browse files Browse the repository at this point in the history
Signed-off-by: tylerslaton <mtslaton1@gmail.com>
  • Loading branch information
tylerslaton committed Mar 6, 2024
1 parent 5785215 commit a24413b
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,23 @@

This project is a Nuxt 3 application for serving documentation for various tools in the gptscript ecosystem.

## Setup
## Local development
To get started locally, follow these steps:

1. Clone this repository:

```bash
git clone https://github.com/gptscript-ai/pkg-gptscript.git
```
```bash
git clone https://github.com/gptscript-ai/pkg-gptscript.git
```

2. Install the dependencies:
2. Create a .env file in the root of your project and add your GitHub token:

```bash
yarn install
```
```bash
GITHUB_TOKEN=your_github_token
```

3. Create a .env file in the root of your project and add your GitHub token:
3. Start the development environment:

```bash
GITHUB_TOKEN=your_github_token
```

4. Start the development server:

```bash
yarn dev
```
```bash
yarn local
```

0 comments on commit a24413b

Please # to comment.