Use setuptools to build the project
This commit is contained in:
35
README.md
35
README.md
@@ -1,10 +1,37 @@
|
||||
# simple_backup
|
||||
simple_backup
|
||||
============
|
||||
A simple backup script
|
||||
|
||||
## Description
|
||||
simple_backup is a Python script that allows you to backup your files.
|
||||
It reads from a configuration file the files/directories that must be copied,
|
||||
the destination directory for the backup and a few other options.
|
||||
Parameters like input files/directories, output directory etc. can be specified in a configuration file, or on the command line. Run:
|
||||
|
||||
```bash
|
||||
simple_backup -h
|
||||
```
|
||||
|
||||
to print all possible command line options.
|
||||
|
||||
## Dependencies
|
||||
rsync is used to perform the backup.
|
||||
The script uses rsync to actually run the backup, so you will have to install it on your system. For example on Arch Linux:
|
||||
|
||||
```bash
|
||||
sudo pacman -Syu rsync
|
||||
```
|
||||
|
||||
## Install
|
||||
To install the program, first clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Fuxino/simple_backup.git
|
||||
```
|
||||
|
||||
Then run:
|
||||
|
||||
```bash
|
||||
cd simple_backup
|
||||
python -m build --wheel
|
||||
python -m installer dist/*.whl
|
||||
|
||||
For Arch Linux, a PKGBUILD that automates this process is provided.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user