Skip to content

Commit f78acf8

Browse files
Develop to main (#10)
* tweaking readme
1 parent 1a37baf commit f78acf8

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,19 @@ This tool will *probably* work on any of the Supernote devices running the most
3737

3838
5. There are three main ways to run the `snbackup` tool from your terminal or command line:
3939
- This will first look for the required **_config.json_** from step **3** in the _.config_ folder (if you ran --setup) and then fallback to looking for the file in your current working directory:
40-
`snbackup`
40+
```bash
41+
snbackup
42+
```
4143

4244
- Use the `-c` or `--config` flag to optionally specify the location of your **_config.json_** file:
43-
`snbackup -c /the/path/to/config.json`
45+
```bash
46+
snbackup -c /the/path/to/config.json
47+
```
4448

4549
- You can also set the environment variable `SNBACKUP_CONF` which points to the location of the **_config.json_**. This allows you to run `snbackup` from anywhere without needing to specify the config file location. The exact command to set environment variables will depend on your operating system and terminal shell.
46-
`export SNBACKUP_CONF="/path/to/config.json"`
50+
```bash
51+
export SNBACKUP_CONF="/path/to/config.json"
52+
```
4753

4854
---
4955

@@ -89,19 +95,29 @@ If no destination is specified after the `-d` flag the device Document folder is
8995
9096
## Additional Options:
9197
- Show all available command line options:
92-
`snbackup -h`
98+
```bash
99+
snbackup -h
100+
```
93101
94102
- Inspect new files to be downloaded from device but do not download:
95-
`snbackup -i`
103+
```bash
104+
snbackup -i
105+
```
96106
97107
- List out date and size information for backups found locally:
98-
`snbackup -ls`
108+
```bash
109+
snbackup -ls
110+
```
99111
100112
- The full backup flag will ignore previously saved backups and force the tool to redownload everything from device:
101-
`snbackup -f`
113+
```bash
114+
snbackup -f
115+
```
102116
103117
- Remove all but the specified number of backups from your local backup directory. This example will keep only the 5 most recent backups and delete any older ones:
104-
`snbackup --cleanup 5`
118+
```bash
119+
snbackup --cleanup 5
120+
```
105121
106122
---
107123
### Additional configuration options can be set in the config.json file.

0 commit comments

Comments
 (0)