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
+7
View File
@@ -0,0 +1,7 @@
Copyright 2026 Lara Jensen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+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.
```