Add README.md. Add setup to README.md. Add MIT license to LICENSE.md

This commit is contained in:
2026-05-03 01:40:25 +02:00
parent 2c4070d24b
commit 358da9285a
2 changed files with 35 additions and 0 deletions
+28
View File
@@ -0,0 +1,28 @@
# Directory Backup Script
A simple script that backs up a directory to another directory, and removes old backups when over a specified limit.
This script is currently used to backup git.getagripgal.nl to several backup sites over samba.
## Setup
```bash
# Setup a venv (Optional)
python -m venv .
source bin/activate
# Install the dependencies.
python -m pip install -p requirements.txt
# Run the script (After setting up the .env file.)
python main.py
```
## Config
The config is stored in the `.env` file.
```env
SOURCE_DIR= # The source directory to backup.
BACKUP_DIR= # The resulting directory the backups get copied to.
MAX_BACKUPS= # The maximum amount of backups stored at a time.
```