Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: style README #75

Merged
merged 3 commits into from
Jan 30, 2023
Merged

docs: style README #75

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b530c8a
style: use `---` over `<hr>`
scarf005 Jan 24, 2023
d070117
style: syntax highlight code block
scarf005 Jan 24, 2023
2c6bf8b
style: <br> to trailing spaces
scarf005 Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ You may need to log out and log in to see all the changes.
### Wipe all profiles
`konsave -w` or `konsave --wipe`

<br><hr><br>


---


## Editing the configuration file
You can make changes to Konsave's configuration file according to your needs. The configuration file is located in `~/.config/konsave/config.yaml`.
Expand All @@ -48,7 +49,7 @@ For KDE Plasma users, the configuration file will be pre-configured.

### Format
The configuration file should be formatted in the following way:
```
```yaml
---
save:
name:
Expand All @@ -72,7 +73,7 @@ export:

### Adding more files/folders to backup
You can add more files/folders in the configuration file like this:
```
```yaml
save:
name:
location: "path/to/parent/directory"
Expand Down Expand Up @@ -102,15 +103,15 @@ The best example for this is the ".default-release" folder of firefox.
`${BEGINS_WITH="text"}`: for folders with different names on different computers whose names start with the same thing.


```
```yaml
save:
firefox:
location: "$HOME/.mozilla/firefox/${ENDS_WITH='.default-release'}"
entries:
- chrome
```

<hr>
---

## Contributing
Please read [CONTRIBUTION.md](https://github.com/Prayag2/konsave/blob/master/CONTRIBUTION.md) for info about contributing.
Expand Down