Skip to content

Commit

Permalink
docs: improve setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
eseidel committed Aug 12, 2024
1 parent 5159d90 commit 463320d
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,26 @@ A Dart client for spacetraders.io.
`openapi` is generated (and pretty terrible code).
`server` and `ui` are mostly stubs.

## Setup
## Setup for running

Set `ST_AGENT` to your desired agent name. If your agent name is reserved
you'll also need to set `ST_EMAIL`.

You can reserve your name by donating to spacetraders.

```
export ST_AGENT=yourname

Check warning on line 27 in README.md

View workflow job for this annotation

GitHub Actions / 🔤 Check Spelling / build

Unknown word (yourname)
```

And then otherwise just run:
```
snap install docker
docker compose up --build
```

You only need to set `ST_AGENT` the first run, after that it saves it in the db.

## Setup (for development)

This should work on any platform, but probably runs best on Linux.

Expand Down Expand Up @@ -57,6 +76,12 @@ cd packages/cli
dart test
```

You may also want to set up git if you haven't
```
git config --global user.email "[email protected]"
git config --global user.name "Your Name"
```

## Usage

The client originally ran as a single program using JSON files for state.
Expand Down

0 comments on commit 463320d

Please sign in to comment.