Skip to content

Commit

Permalink
docs: small update
Browse files Browse the repository at this point in the history
  • Loading branch information
mablin7 committed May 30, 2024
1 parent 4a9d8a4 commit 21e3bf1
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 6 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ The following options are required:

- `-m`: Mode: `sim` for simulation, `irl` for real robot. `irl-test` allows manual control of the robot over the web interface.

See [http://docs.delftmercurians.nl/](http://docs.delftmercurians.nl/) for the latest documentation.

## Crates

Dies is split into several crates, each with a specific purpose:
Expand All @@ -43,8 +45,3 @@ Dies is split into several crates, each with a specific purpose:
- ![`dies-world`](./crates/dies-world): Contains the `World` type, which is used to represent the state of the game world, as well as filters and processors for incoming data.
- ![`dies-webui`](./crates/dies-webui): Contains the backend for the web interface, which can be used to monitor and control the AI. The frotend is in the `webui` directory.
- ![`dies-cli`](./crates/dies-cli): Contains the command line interface for running the AI. This is the main entry point for the framework.


## Documentation

See [http://docs.delftmercurians.nl/](http://docs.delftmercurians.nl/) for the latest documentation.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [Setting Up](./setting_up.md)
- [Developer Guide](./dev.md)
- [Architecture Overview](./architecture.md)
- [Strategy Overivew](./strategy.md)

# Using Dies

Expand Down
2 changes: 1 addition & 1 deletion docs/src/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ dies-core ------------> dies-cli
+- feature crates -+
```

There should be a few root crates (`dies-core`) which will rarely change, a number of specialized feature crates (`dies-ersim-env`, `dies-python-rt`, etc.), and a few small leaf crates which just glue things together (`dies-cli`).
There should be a few root crates (`dies-core`) which will rarely change, a number of specialized feature crates (`dies-serial-client`, `dies-executor`, etc.), and a few small leaf crates which just glue things together (`dies-cli`).

For an up-to-date list of crates, see the README.

Expand Down
Empty file added docs/src/strategy.md
Empty file.

0 comments on commit 21e3bf1

Please sign in to comment.