From 7fe61d995b2dc3c7187acb217b5754a177372a5e Mon Sep 17 00:00:00 2001 From: mitmarcus <114725463+mitmarcus@users.noreply.github.com> Date: Tue, 5 Sep 2023 14:09:33 +0300 Subject: [PATCH 1/2] Update README.md groupped documentation to be more readable --- docs/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 18ff5b3..61e5aa6 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": +### About the device + - [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of - [Hardware](./hardware.md): Learn to know the hardware of your Chameleon - [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. - -- [Quickstart](./quickstart.md): for the impatient people to just get you up and running with anything. +### For developers - [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. +### Miscellaneous + - [Modding](./modding.md): third party moddings worth mentioning. + +- [FAQ](./faq.md): Frequently Asked Questions, if you have a question, it might already be answered here. From ea67c5cec533203132e32241a6a8e16fd995da81 Mon Sep 17 00:00:00 2001 From: mitmarcus <114725463+mitmarcus@users.noreply.github.com> Date: Tue, 5 Sep 2023 14:21:48 +0300 Subject: [PATCH 2/2] Update README.md --- docs/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 61e5aa6..25921f4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,17 +6,17 @@ This Guide is split up into multiple "subguides": ### About the device -- [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of +- [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of. -- [Hardware](./hardware.md): Learn to know the hardware of your Chameleon +- [Hardware](./hardware.md): Learn to know the hardware of your Chameleon. -- [Firmware](./firmware.md): Your Chameleon runs a firmware, learn what it can do and how to use it +- [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. +- [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. +- [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. @@ -24,12 +24,12 @@ This Guide is split up into multiple "subguides": ### For developers -- [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): Frequently Asked Questions, if you have a question, it might already be answered here. +- [FAQ](./faq.md): **F**requently **A**sked **Q**uestions, if you have a question, it might already be answered here.