-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
``` | ||
|
||
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. | ||
|
||
|
@@ -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. | ||
|