Skip to content

Commit 8d3724e

Browse files
committed
Optimize readme
1 parent 9b1a229 commit 8d3724e

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Some very basic linux skills are necessary. Should also work with a "Raspberry P
1313
This project is open source software licensed via [GNU General Public License v3.0](LICENSE), use at your own risk.
1414

1515
## Quickstart
16-
Basic process:
16+
**Basic process:**
1717
Install a Raspberry Pi Zero W, adjust project config.json, copy project files to home directory of the Raspi and execute the setup script.
1818

1919
The Micro-SD card should have at least 16GB.
@@ -35,15 +35,13 @@ The Micro-SD card should have at least 16GB.
3535

3636
4. Update settings in configuration file `config.json`:
3737

38-
| Entry | Description |
39-
|----------------------|---------------|
40-
| ActivateDropboxSync | Activate (1) or deactivate (0) sync to dropbox |
41-
| Dropbox... | [Prepare and configure for Dropbox sync](doc/dropbox.md) |
42-
| ActivateScpSync | Activate (1) or deactivate (0) sync to a linux server via SCP |
43-
| Scp... | [Prepare and configure for linux server sync](doc/scp.md) |
44-
| KeepMaxFilesOnUSB | Maximum number of files kept in the Raspi USB image |
45-
| DeleteOnUSBCycleTime | Cycle time in seconds after which files above KeepMaxFilesOnUSB are deleted |
46-
| CopyCheckCycleTime | Cycle time in seconds after which the Raspi USB image is checked for new files |
38+
| Entry | Description |
39+
|----------------------|---------------|
40+
| ActivateDropboxSync | Activate (1) or deactivate (0) sync to dropbox |
41+
| Dropbox... | [Prepare and configure for Dropbox sync](doc/dropbox.md) |
42+
43+
[Click here for all possible settings.](doc/settings.md)
44+
4745

4846
5. Copy all extracted and updated files from `home_pi` to `/home/pi` on the Raspberry Pi.
4947

doc/img/dropboxapp.png

-108 KB
Loading

doc/settings.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# All settings in config.json
2+
3+
| Entry | Description |
4+
|----------------------|---------------|
5+
| ActivateDropboxSync | Activate (1) or deactivate (0) sync to dropbox |
6+
| Dropbox... | [Prepare and configure for Dropbox sync](doc/dropbox.md) |
7+
| ActivateScpSync | Activate (1) or deactivate (0) sync to a linux server via SCP |
8+
| Scp... | [Prepare and configure for linux server sync](doc/scp.md) |
9+
| KeepMaxFilesOnUSB | Maximum number of files kept in the Raspi USB image |
10+
| DeleteOnUSBCycleTime | Cycle time in seconds after which files above KeepMaxFilesOnUSB are deleted |
11+
| CopyCheckCycleTime | Cycle time in seconds after which the Raspi USB image is checked for new files |

0 commit comments

Comments
 (0)