Skip to content

Commit fa5814e

Browse files
committed
change to use mermaid in protocols docs
1 parent 89415c0 commit fa5814e

108 files changed

Lines changed: 5248 additions & 595 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Home.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,32 @@ This Guide is split up into multiple "subguides":
66

77
### About the device
88

9-
- [[Whitepaper|technical_whitepaper]]: Discover what the Chameleon Ultra is capable of.
9+
- [Whitepaper](./technical_whitepaper.md): Discover what the Chameleon Ultra is capable of.
1010

11-
- [[Hardware|hardware]]: Learn to know the hardware of your Chameleon.
11+
- [Hardware](./hardware.md): Learn to know the hardware of your Chameleon.
1212

13-
- [[Firmware|firmware]]: Your Chameleon runs a firmware, learn what it can do and how to use it.
13+
- [Firmware](./firmware.md): Your Chameleon runs a firmware, learn what it can do and how to use it.
1414

1515
### Interacting with the device
1616

17-
- [[Quickstart|quickstart]]: For the impatient people to just get you up and running with anything.
17+
- [Quickstart](./quickstart.md): For the impatient people to just get you up and running with anything.
1818

19-
- [[CLI|cli]]: 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.
19+
- [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.
2020

21-
- [[GUIs|gui]]: 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.
21+
- [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.
2222

23-
- [[Troubleshooting|troubleshooting]]: For when things go wrong, here are some common tips to maybe fix whatever issue you might have.
23+
- [Troubleshooting](./troubleshooting.md): For when things go wrong, here are some common tips to maybe fix whatever issue you might have.
2424

2525
### For developers
2626

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

29-
- [[SDKs|sdk]]: SDKs for Chameleon, useful if you want to develop your own application to control Chameleon.
29+
- [SDKs](./sdk.md): SDKs for Chameleon, useful if you want to develop your own application to control Chameleon.
3030

31-
- [[Protocol|protocol]]: The gory details of the communication protocol, useful if you want to develop your own client.
31+
- [Protocol](./protocol/README.md): The gory details of the communication protocol, useful if you want to develop your own client.
3232

3333
### Miscellaneous
3434

35-
- [[Modding|modding]]: Third party moddings worth mentioning.
35+
- [Modding](./modding.md): Third party moddings worth mentioning.
3636

37-
- [[FAQ|faq]]: **F**requently **A**sked **Q**uestions, if you have a question, it might already be answered here.
37+
- [FAQ](./faq.md): **F**requently **A**sked **Q**uestions, if you have a question, it might already be answered here.

chameleonultragui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The *Mifare Classic emulator settings* section allows you to toggle various beha
6565
- *Gen2 Magic Mode*: behaves like a gen2 magic card, makes Block 0 writable ;
6666
- *Use UID/SAK/ATQA from 0 block*: the Chameleon Ultra stores the UID and other anti-collision data independently of the card content. Enabling this setting tells the Chameleon to derive them from card content block 0. Only for MFC with 4-byte UID ;
6767
- *Collect nonces (Mfkey32)*: it toggles nonce collection for mfkey32. When enabled you will be prompted to present the Chameleon to a reader. After you have collected nonces the *Present Chameleon to reader* message will change into a *Recover Keys from x nonces* button. Pressing this will start the recovery process ;
68-
- *Write mode*: Please refer to the [[firmware docs|firmware]].
68+
- *Write mode*: Please refer to the [firmware docs](./firmware.md).
6969

7070
### Search dialog
7171
![Search Dialog](./images/cugui-searchdialog.png)

firmware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Chameleon flash contains several parts: the bootloader and its settings, the application, the user data and the SoftDevice.
44

5-
NOTE: If you are a developer searching for the building instructions, look into [[development|development]]
5+
NOTE: If you are a developer searching for the building instructions, look into [development](./development.md).
66

77
## The Bootloader
88

gui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
There are multiple GUIs to control your Chameleon, two are featured in this documentation.
44
Note that in spite of what their name may suggest, all GUIs support both the Ultra and the Lite.
55

6-
- [[Chameleon Ultra GUI|chameleonultragui]] ([github](https://github.com/GameTec-live/ChameleonUltraGUI))
6+
- [Chameleon Ultra GUI](./chameleonultragui.md) ([github](https://github.com/GameTec-live/ChameleonUltraGUI))
77

88
- [MTools Lite for iOS](https://shop.mtoolstec.com/mifare-classic-tool-for-ios)

0 commit comments

Comments
 (0)