From eb8e3ed46acb0d631175c7af5e100731dd54f8e9 Mon Sep 17 00:00:00 2001 From: StoyanDimitrov Date: Sat, 13 Apr 2019 15:31:35 +0000 Subject: [PATCH] Improve readability of code filenames --- docs/solo/code-overview.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/solo/code-overview.md b/docs/solo/code-overview.md index 9852cd9..d4f09c5 100644 --- a/docs/solo/code-overview.md +++ b/docs/solo/code-overview.md @@ -5,22 +5,22 @@ and easy to understand, especially when paired with a high level overview. ## FIDO2 codebase -* main.c - calls high level functions and implements event loop. +* `main.c` - calls high level functions and implements event loop. -* ctaphid.c - implements [USBHID protocol](https://fidoalliance.org/specs/fido-v2.0-id-20180227/fido-client-to-authenticator-protocol-v2.0-id-20180227.html#usb) for FIDO. +* `ctaphid.c` - implements [USBHID protocol](https://fidoalliance.org/specs/fido-v2.0-id-20180227/fido-client-to-authenticator-protocol-v2.0-id-20180227.html#usb) for FIDO. -* u2f.c - implements [U2F protocol](https://fidoalliance.org/specs/fido-u2f-v1.2-ps-20170411/fido-u2f-raw-message-formats-v1.2-ps-20170411.html). +* `u2f.c` - implements [U2F protocol](https://fidoalliance.org/specs/fido-u2f-v1.2-ps-20170411/fido-u2f-raw-message-formats-v1.2-ps-20170411.html). -* ctap.c - implements [CTAP2 protocol](https://fidoalliance.org/specs/fido-v2.0-id-20180227/fido-client-to-authenticator-protocol-v2.0-id-20180227.html). +* `ctap.c` - implements [CTAP2 protocol](https://fidoalliance.org/specs/fido-v2.0-id-20180227/fido-client-to-authenticator-protocol-v2.0-id-20180227.html). -* ctap_parse.c - implements parsing for CTAP protocol. +* `ctap_parse.c` - implements parsing for CTAP protocol. * this could use some work minimizing. -* log.c - embedded friendly debug logging. +* `log.c` - embedded friendly debug logging. -* crypto.c - software implementation of the crypto needs of the application. Generally this will be copied and edited for different platforms. API defined in crypto.h should be the same. +* `crypto.c` - software implementation of the crypto needs of the application. Generally this will be copied and edited for different platforms. API defined in `crypto.h` should be the same. -* device.h - definitions of functions that are platform specific and should be implemented separately. See device.c in any of the implementations to see examples. +* `device.h` - definitions of functions that are platform specific and should be implemented separately. See `device.c` in any of the implementations to see examples. ## Data flow