readme edits
This commit is contained in:
parent
360f7e502f
commit
4b1dddd6ef
2 changed files with 13 additions and 1 deletions
13
readme.md
13
readme.md
|
@ -107,7 +107,7 @@ norg -c myconfig.toml forget -r MyBorgRepo -a a1b2c3d4
|
|||
* `-a`, `--archive`: The Archive to operate on (snapshots for restic)
|
||||
* `-d`, `--destination`: When extracting/restoring, the destination for the extracted files
|
||||
|
||||
# Build from Source
|
||||
## Build from Source
|
||||
Download and build from source
|
||||
```sh
|
||||
git clone https://codeberg.org/pswilde/norgbackup
|
||||
|
@ -121,6 +121,17 @@ or just install directly with `nimble`
|
|||
nimble install https://codeberg.org/pswilde/norgbackup
|
||||
```
|
||||
|
||||
## System Support
|
||||
Norg should work on any system that can compile `nim` code with `nimble`.
|
||||
Tested on:
|
||||
* Arch Linux
|
||||
* Debian Linux
|
||||
* AlmaLinux
|
||||
* FreeBSD
|
||||
|
||||
But in general all Linux distributions and BSDs should work if borg and/or restic is installed.
|
||||
Windows support (Restic only until Borg support in Windows is available) is planned with the only real issue being finding the restic executable. Should be an easy fix.
|
||||
|
||||
## Naming. Why "Norg"?
|
||||
Well, I don't know. I'm a Star Trek fan so obviously I wanted to keep something
|
||||
in line with the [Borg pseudo-species](https://memory-alpha.fandom.com/wiki/Borg) as the borg backup utility does.
|
||||
|
|
1
todo.md
1
todo.md
|
@ -7,4 +7,5 @@
|
|||
- [ ] Generate config command parameter
|
||||
- [x] Allow to specify direct repository so mount/extract doesn't fail if multiple are available
|
||||
- [ ] Better workflow of using borg flags and options as it seems a little sketchy just passing them through to the command string
|
||||
- [ ] Add Windows support (Restic Only)
|
||||
- [ ] ... and loads more
|
||||
|
|
Loading…
Reference in a new issue