Skip to content

Commit

Permalink
getting_started.md Improve options table readability
Browse files Browse the repository at this point in the history
Make the table looking better even in raw text mode
Replace “” quotes with ""
  • Loading branch information
stokito authored and aajain-com committed May 20, 2021
1 parent b171c17 commit d3eb6f8
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions Documentation/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@ is the SSH password; both of these were chosen during the initial `raspi_sdcard_
```

## Make options
Commmand | Description
-------------------------------- | -------------------------------------------------------------------
make ? | <ul><li>apps - Build all apps (Default)</li></li><li>test - Build unit tests</li><li>all - Build apps and unit tests</li></ul>
make APPS=? | Space delimited names of the app to compile. <br><br>Example: `make APPS=Lightbulb Lock`<br><br> Default: All applications
make BUILD_TYPE=? | Build type: <br><ul><li>Debug (Default)</li><li>Test</li><li>Release</li></ul>
make CRYPTO=? | Supported cryptographic libraries: <br><ul><li>OpenSSL (Default)</li><li>MbedTLS</li></ul>Example: `make CRYPTO=MbedTLS apps`
make DOCKER=? | Build with or without Docker: <br><ul><li>1 - Enable Docker during compilation (Default)</li><li>0 - Disable Docker during compilation</li></ul>
Command | Description
-------------------- | -------------------------------------------------------------------
make ? | <ul><li>apps - Build all apps (Default)</li></li><li>test - Build unit tests</li><li>all - Build apps and unit tests</li></ul>
make APPS=? | Space delimited names of the app to compile. <br><br>Example: `make APPS="Lightbulb Lock"`<br><br> Default: All applications
make BUILD_TYPE=? | Build type: <br><ul><li>Debug (Default)</li><li>Test</li><li>Release</li></ul>
make CRYPTO=? | Supported cryptographic libraries: <br><ul><li>OpenSSL (Default)</li><li>MbedTLS</li></ul> Example: `make CRYPTO=MbedTLS apps`
make DOCKER=? | Build with or without Docker: <br><ul><li>1 - Enable Docker during compilation (Default)</li><li>0 - Disable Docker during compilation</li></ul>
make LOG_LEVEL=level | <ul><li>0 - No logs are displayed (Default for release build)</li><li>1 - Error and Fault-level logs are displayed (Default for test build)</li><li>2 - Error, Fault-level and Info logs are displayed</li><li>3 - Error, Fault-level, Info and Debug logs are displayed (Default for debug build)</li></ul>
make PROTOCOLS=? | Space delimited protocols supported by the applications: <br><ul><li>BLE</li><li>IP</li></ul><br>Example: `make PROTOCOLS=IP BLE`<br><br>Default: All protocols
make TARGET=? | Build for a given target platform:<br><ul><li>Darwin</li><li>Linux</li></li><li>Raspi</li></ul>
make USE_DISPLAY=? | Build with display support enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_HW_AUTH=? | Build with hardware authentication enabled: <br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_NFC=? | Build with NFC enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_WAC=? | Build with WAC enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make PROTOCOLS=? | Space delimited protocols supported by the applications: <br><ul><li>BLE</li><li>IP</li></ul><br> Example: `make PROTOCOLS="IP BLE"`<br><br>Default: All protocols
make TARGET=? | Build for a given target platform:<br><ul><li>Darwin</li><li>Linux</li></li><li>Raspi</li></ul>
make USE_DISPLAY=? | Build with display support enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_HW_AUTH=? | Build with hardware authentication enabled: <br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_NFC=? | Build with NFC enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>
make USE_WAC=? | Build with WAC enabled:<br><ul><li>0 - Disable (Default)</li><li>1 - Enable</li></ul>

1 comment on commit d3eb6f8

@ModestGoblin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

incredible?

Please sign in to comment.