From 6d096df88b0b6eac52dc7b9ed0ece77995b1f4b0 Mon Sep 17 00:00:00 2001 From: Philippe Teuwen Date: Fri, 25 Aug 2023 22:55:05 +0200 Subject: [PATCH] readme --- README.md | 62 +++++++------------ .../technical_whitepaper.md | 0 2 files changed, 21 insertions(+), 41 deletions(-) rename Technical_White_Paper.md => docs/technical_whitepaper.md (100%) diff --git a/README.md b/README.md index 2432eba..4d886f1 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,28 @@ -[tech_white_paper]: https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/Technical_White_Paper.md +![logo](resource/picture/Header.png) -[how_use_firmware]: https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/How_to_use_Firmware.md +![hardware picture](resource/picture/Hardware%20Photos.png) -[go_to_buy_lab401]: https://lab401.com/ +# ChameleonUltra Authorized Distributors -[go_to_buy_hackerwarehouse]: https://hackerwarehouse.com/ +Europe: [Lab401](https://lab401.com/) -[go_to_buy_sneaktechnology]: https://sneaktechnology.com +United States: [Hackerwarehouse](https://hackerwarehouse.com/) -[go_to_buy_proxgrind_aliexpress]: https://proxgrind.aliexpress.com/store/1101312023 +Anywhere else: [Sneaktechnology](https://sneaktechnology.com) / [Aliexpress by RRG](https://proxgrind.aliexpress.com/store/1101312023) + +# What is it and how to use ? + +Read the [available documentation](docs/home.md). + +# Compatible applications + +* [ChameleonUltraGUI](https://github.com/GameTec-live/ChameleonUltraGUI) + +# Videos + +*Beware some of the instructions might have changed since recording, theck the current documentation in doubt!* + +* [Downloading and compiling the official CLI](https://www.youtube.com/watch?v=VGpAeitNXH0) +* [Downloading ChameleonUltraGUI](https://www.youtube.com/watch?v=rHH7iqbX3nY) -![alt text](https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/resource/picture/Header.png) - -# ChameleonUltra Authorised Distributors - -Europe: [Lab401][go_to_buy_lab401] - -United States: [Hackerwarehouse][go_to_buy_hackerwarehouse] - -Anywhere else: [Sneaktechnology][go_to_buy_sneaktechnology] / [Aliexpress by RRG][go_to_buy_proxgrind_aliexpress] - -# How to use ? - -- ChameleonUltra: [Technical White Paper][tech_white_paper] (Old content of this readme in here) -- ChameleonUltra: [Firmware][./docs/development.md] - -More Coming Soon. - -# Videos to reference - -Downloading and compiling the CLI - -https://www.youtube.com/watch?v=VGpAeitNXH0 - -Downloading a GUI - -https://www.youtube.com/watch?v=rHH7iqbX3nY - -Link to the GUI - -https://github.com/GameTec-live/ChameleonUltraGUI - -# Hardware Pictures - -![alt text](https://github.com/RfidResearchGroup/ChameleonUltra/blob/main/resource/picture/Hardware%20Photos.png) - diff --git a/Technical_White_Paper.md b/docs/technical_whitepaper.md similarity index 100% rename from Technical_White_Paper.md rename to docs/technical_whitepaper.md