Skip to content

Commit 0873a4a

Browse files
committed
README installation screenshots
1 parent bbcc523 commit 0873a4a

File tree

9 files changed

+69
-1
lines changed

9 files changed

+69
-1
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,61 @@ TurtlPass Firmware provides a simple and secure way of generating passwords usin
4343
* No power input
4444

4545

46+
## Installation and getting started
47+
48+
### 1. Install the Arduino Legacy IDE (1.8.19)
49+
50+
The Arduino IDE 1.8.19 can be downloaded from this [link](https://www.arduino.cc/en/software)
51+
52+
> 1.8.X version is required beforehand to ensure device drivers are installed correctly but 2.X can be used once the following steps are completed
53+
54+
55+
### 2. Install the Raspberry Pi RP2040 Boards
56+
57+
- Open `File` -> `Preferences` -> `Settings`
58+
59+
- Insert the following link into the **Additional Boards Manager URLs**:
60+
61+
> https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
62+
63+
- Hit **OK** to close the dialog
64+
65+
<details>
66+
<summary>Screenshot</summary>
67+
68+
<img src="assets/additional_boards.png" width="100%">
69+
</details>
70+
71+
72+
### 3. Install Pico Board package
73+
74+
- Go to `Tools` -> `Board` -> `Boards Manager...`
75+
76+
- Search for "pico"
77+
78+
- Install the package "Raspberry Pi Pico/RP 2040"
79+
80+
<details>
81+
<summary>Screenshots</summary>
82+
83+
<img src="assets/boards_manager.png" width="100%">
84+
<img src="assets/boards_manager_pico.png" width="100%">
85+
</details>
86+
87+
88+
### 4. Select Raspberry Pi Pico Board
89+
90+
- Go to `Tools` -> `Board` -> `Raspberry Pi RP2040 Boards(1.9.5)`
91+
92+
- And select `Raspberry Pi Pico`
93+
94+
<details>
95+
<summary>Screenshot</summary>
96+
97+
<img src="assets/select_pico_board.png" width="100%">
98+
</details>
99+
100+
46101
## πŸ”§ Generate your own seed
47102

48103
1. Run the bash script `./generate_seed_file.sh` to generate a new seed file `Seed.cpp.<timestamp>` on a computer with macOS or Linux.
@@ -52,7 +107,6 @@ TurtlPass Firmware provides a simple and secure way of generating passwords usin
52107

53108
## ⬆️ Upload sketch
54109

55-
56110
1. Open `turtlpass-firmware.ino` with Arduino IDE on a computer.
57111

58112
> If the first time, select the appropriate **Board** and **Serial Port** in the Arduino menu `Tools`.
@@ -65,6 +119,13 @@ TurtlPass Firmware provides a simple and secure way of generating passwords usin
65119

66120
4. The sketch should be transferred and start to run.
67121

122+
<details>
123+
<summary>Screenshots</summary>
124+
125+
<img src="assets/upload_firmware.png" width="50%">
126+
<img src="assets/upload_done.png" width="50%">
127+
</details>
128+
68129

69130
## 🐞 Debugging
70131

@@ -77,6 +138,13 @@ TurtlPass Firmware provides a simple and secure way of generating passwords usin
77138

78139
4. Now press the button on Pico and the password should be typed (wherever the focus is on)
79140

141+
<details>
142+
<summary>Screenshots</summary>
143+
144+
<img src="assets/serial_monitor_send.png" width="100%">
145+
<img src="assets/serial_monitor_result.png" width="100%">
146+
</details>
147+
80148

81149
## πŸ›‘οΈ Security
82150

β€Žassets/additional_boards.pngβ€Ž

128 KB
Loading

β€Žassets/boards_manager.pngβ€Ž

203 KB
Loading
110 KB
Loading

β€Žassets/select_pico_board.pngβ€Ž

323 KB
Loading
63.5 KB
Loading
70.1 KB
Loading

β€Žassets/upload_done.pngβ€Ž

33.8 KB
Loading

β€Žassets/upload_firmware.pngβ€Ž

23.9 KB
Loading

0 commit comments

Comments
Β (0)