diff --git a/README.md b/README.md index e839ce4c..9e451ba0 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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. diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 5b2eb4aa..5f2fab8c 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -5,6 +5,7 @@ - [Setting Up](./setting_up.md) - [Developer Guide](./dev.md) - [Architecture Overview](./architecture.md) +- [Strategy Overivew](./strategy.md) # Using Dies diff --git a/docs/src/dev.md b/docs/src/dev.md index 5eb68195..14aded4b 100644 --- a/docs/src/dev.md +++ b/docs/src/dev.md @@ -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. diff --git a/docs/src/strategy.md b/docs/src/strategy.md new file mode 100644 index 00000000..e69de29b