From 86067576d825f2b24abbc35ce7e163471520e7fc Mon Sep 17 00:00:00 2001 From: Philippe Teuwen Date: Fri, 25 Aug 2023 23:51:51 +0200 Subject: [PATCH] doc --- README.md | 2 +- docs/README.md | 25 +++++++++++++++++++++++++ docs/home.md | 21 --------------------- 3 files changed, 26 insertions(+), 22 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/home.md diff --git a/README.md b/README.md index c63511c..c867134 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Anywhere else: [Sneaktechnology](https://sneaktechnology.com) / [Aliexpress by R # What is it and how to use ? -Read the [available documentation](docs/home.md). +Read the [available documentation](docs/README.md). # Compatible applications diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..918abb5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,25 @@ +# Chameleon Ultra Guide + +This guide goal is to guide you through setting up and using your Chameleon Ultra and Lite. + +This Guide is split up into multiple "subguides": + +- ["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 + +- ["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. + +- ["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. diff --git a/docs/home.md b/docs/home.md deleted file mode 100644 index 98aaa6a..0000000 --- a/docs/home.md +++ /dev/null @@ -1,21 +0,0 @@ -# Chameleon Ultra Guide - -This guides goal is to guide you through setting up and using your Chameleon Ultra and Lite. - -This Guide is split up into multiple "subguides": - -- ["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 - -- ["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), theese 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 awnsered here. - -- ["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 enviroment.