Skip to content

Commit

Permalink
Merge pull request #126 from mitmarcus/patch-6
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
doegox authored Sep 5, 2023
2 parents 6294638 + ea67c5c commit 47aed37
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

- [Development](./development.md): For all developers. This covers how to build firmware from source and set up a development environment.

- [Quickstart](./quickstart.md): for the impatient people to just get you up and running with anything.
- [Protocol](./protocol.md): The gory details of the communication protocol, useful if you want to develop your own client.

- [Development](./development.md): for all developers. This covers how to build firmware from source and set up a development environment.
### Miscellaneous

- [Protocol](./protocol.md): the gory details of the communication protocol, useful if you want to develop your own client.
- [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.

0 comments on commit 47aed37

Please sign in to comment.