initial README.md

README.md

@@ -0,0 +1,49 @@
+<!-- bsbr README.md -->
+<!-- version: 0.0.1 -->
+
+<!-- [Logo-bsbr]: https://github.com/rzerres/usr/share/pixmaps/bsbr_logo.png "bsbr Logo" -->
+<!-- [Logo-bsbr]: usr/share/pixmaps/bsbr_logo.svg "bsbr Logo" -->
+<!-- ![Logo-bsbr] -->
+
+![Logo-bsbr](usr/share/pixmaps/bsbr_logo.png "Welcome to bsbr")
+
+# Proposal: About
+
+`bsbr` is designed as a backup and restore tool that completly relies on
+btrfs formated filesystems.
+It takes advantage of the btrfs snapshot functionality and combines it
+with management functionality of snapper.
+
+`bsbr` creates backups as btrfs-snapshots on a selectable target device.
+Plug in and mount any btrfs-formatted device to your system. Supported devices
+may be either local USB drives, but can be as well remote accessible RAID drives.
+If possible the backup process will send incremental snapshots to the target drive.
+If the snapshot will be stored on a remote host, it is secured with ssh.
+
+`bsbr` will support interactive and time scheduled backup runs.
+
+# Proposal: Structure
+
+* bsbr        - gui component
+* bsbrctl     - commandline component
+* bsbr-snap   - snapshot given btrfs subvolume
+* bsbr-clone  - archive/clone a given btrfs subvolume
+* bsbr-restor - restore selected files from given snapshot to selectable destination
+
+## Contributing
+
+Help is very welcome! Feel free to fork and issue a pull request to add features or
+tackle open issues. If you are requesting new features, please have a look at the
+TODO list. It might be already on the agenda.
+
+## License
+
+<!-- License source -->
+[Logo-CC_BY]: https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Common Logo"
+[License-CC_BY]: https://creativecommons.org/licenses/by/4.0/legalcode "Creative Common License"
+
+This work is licensed under a [Creative Common License 4.0][License-CC_BY]
+
+![Creative Common Logo][Logo-CC_BY]
+
+© 2018 Ralf Zerres