From 32ef8923fcbac89dccb17505cba4d228b5467aa8 Mon Sep 17 00:00:00 2001
From: Ori <45724082+therealOri@users.noreply.github.com>
Date: Tue, 15 Feb 2022 14:18:57 -0700
Subject: [PATCH 1/2] Spacing
Added some spacing `
` in the readme for better readability.
---
README.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/README.md b/README.md
index 5fe61326..f90956c1 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@ This repo contains the Solo firmware, including implementations of FIDO2 and U2F
For development no hardware is needed, Solo also runs as a standalone application for Windows, Linux, and Mac OSX. If you like (or want to learn) hardware instead, you can run Solo on the NUCLEO-L432KC development board, or we make Solo for Hacker, an unlocked version of Solo that lets you customize its firmware.
+
+
# Security
@@ -23,6 +25,8 @@ Solo is based on the STM32L432 microcontroller. It offers the following security
- 256 KB of memory to support hardened crypto implementations and, later, additional features such as OpenPGP or SSH.
- No NDA needed to develop for.
+
+
# Solo for Hackers
@@ -41,6 +45,9 @@ In the Hacker version, hardware is the same but the firmware is unlocked, so you
Hacker Solo isn't really secure so you should only use it for development. An attacker with physical access to a Solo for Hacker can reflash it following the steps above, and even a malware on your computer could possibly reflash it.
+
+
+
## Checking out the code
```bash
git clone --recurse-submodules https://github.com/solokeys/solo
@@ -51,6 +58,9 @@ If you forgot the `--recurse-submodules` while cloning, simply run `git submodul
`make update` will also checkout the latest code on `master` and submodules.
+
+
+
## Checking out the code to build a specific version
You can checkout the code to build a specific version of the firmware with:
@@ -60,6 +70,8 @@ git fetch --tags
git checkout ${VERSION_TO_BUILD}
git submodule update --init --recursive
```
+
+
## Installing the toolchain and applying updates
@@ -67,6 +79,9 @@ In order to compile ARM code, you need the ARM compiler and other things like bu
You can update your solokey after running `pip3 install solo-python` with `solo key update` for the latest version. To apply a custom image use `solo program bootloader (.json|.hex)`.
+
+
+
## Installing the toolkit and compiling in Docker
Alternatively, you can use Docker to create a container with the toolchain.
You can run:
@@ -81,6 +96,9 @@ make docker-build-all
The `builds` folder will contain all the variation on the firmware in `.hex` files.
+
+
+
## Build locally
### Prereqs
@@ -106,6 +124,11 @@ source venv/bin/activate
solo program aux enter-bootloader
solo program bootloader targets/stm32l432/solo.hex
```
+
+
+
+
+
# Developing Solo (No Hardware Needed)
@@ -116,6 +139,7 @@ solo program bootloader targets/stm32l432/solo.hex
```
sudo apt install libsodium-dev
```
+
## Building
@@ -144,11 +168,15 @@ In another shell, you can run our [test suite](https://github.com/solokeys/fido2
You can find more details in our [documentation](https://docs.solokeys.dev/), including how to build on the the NUCLEO-L432KC development board.
+
+
# Documentation
Check out our [official documentation](https://docs.solokeys.dev/).
+
+
# Contributors ✨
@@ -204,6 +232,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
+
+
# License
@@ -223,6 +253,9 @@ You may use Solo documentation under the terms of the CC-BY-SA 4.0 license
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fsolokeys%2Fsolo?ref=badge_large)
+
+
+
# Where To Buy Solo
You can buy Solo, Solo Tap, and Solo for Hackers at [solokeys.com](https://solokeys.com).
From 0a971c4cd6edf30fd7a87f2199ceefc574242f1f Mon Sep 17 00:00:00 2001
From: Ori <45724082+therealOri@users.noreply.github.com>
Date: Tue, 15 Feb 2022 14:23:17 -0700
Subject: [PATCH 2/2] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f90956c1..656541ad 100644
--- a/README.md
+++ b/README.md
@@ -261,7 +261,7 @@ You may use Solo documentation under the terms of the CC-BY-SA 4.0 license
You can buy Solo, Solo Tap, and Solo for Hackers at [solokeys.com](https://solokeys.com).
-
+
[](https://github.com/solokeys/solo/blob/master/LICENSE)