rfidrig/ChameleonUltra
0
0
Fork 0
mirror of https://github.com/RfidResearchGroup/ChameleonUltra.git synced 2026-05-12 11:22:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Philippe Teuwen
2023-08-25 23:51:51 +02:00
parent 249cadc736
commit 86067576d8
3 changed files with 26 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -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
docs/README.md
+25
View File
@@ -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.
docs/home.md
-21
View File
@@ -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.