diff --git a/docs/README.md b/docs/README.md index 18ff5b3..25921f4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,24 +4,32 @@ This guide goal is to guide you through setting up and using your Chameleon Ultr This Guide is split up into multiple "subguides": -- [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of +### About the device -- [Hardware](./hardware.md): Learn to know the hardware of your Chameleon +- [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of. -- [Firmware](./firmware.md): Your Chameleon runs a firmware, learn what it can do and how to use it +- [Hardware](./hardware.md): Learn to know the hardware of your Chameleon. -- [CLI](./cli.md): The official way to control your Chameleon is via the **C**ommand **L**ine **I**nterface (CLI) . Learn how to install and master the CLI. +- [Firmware](./firmware.md): Your Chameleon runs a firmware, learn what it can do and how to use it. + +### Interacting with the device + +- [Quickstart](./quickstart.md): For the impatient people to just get you up and running with anything. + +- [CLI](./cli.md): The official way to control your Chameleon is via the **C**ommand **L**ine **I**nterface (CLI). Learn how to install and master the CLI. - [GUIs](./gui.md): Some people also develop **G**raphical **U**ser **I**nterfaces (GUIs), these may be a good start for people that do not want to deal with a CLI. - [Troubleshooting](./troubleshooting.md): For when things go wrong, here are some common tips to maybe fix whatever issue you might have. -- [FAQ](./faq.md): Frequently Asked Questions, if you have a question, it might already be answered here. +### For developers -- [Quickstart](./quickstart.md): for the impatient people to just get you up and running with anything. +- [Development](./development.md): For all developers. This covers how to build firmware from source and set up a development environment. -- [Development](./development.md): for all developers. This covers how to build firmware from source and set up a development environment. +- [Protocol](./protocol.md): The gory details of the communication protocol, useful if you want to develop your own client. -- [Protocol](./protocol.md): the gory details of the communication protocol, useful if you want to develop your own client. +### Miscellaneous -- [Modding](./modding.md): third party moddings worth mentioning. +- [Modding](./modding.md): Third party moddings worth mentioning. + +- [FAQ](./faq.md): **F**requently **A**sked **Q**uestions, if you have a question, it might already be answered here.