diff options
| author | Craig Jennings <c@cjennings.net> | 2026-01-29 12:32:23 -0600 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-01-29 12:32:23 -0600 |
| commit | b5d7f4df21782a1e34c89d17e8a6902fe2940182 (patch) | |
| tree | 8fbc1860fdd8bcbf5735a748e270dc6dc8c96c75 | |
| parent | 894f1f18be1ce0e1c03230df23154be6778488dd (diff) | |
| download | rsyncshot-b5d7f4df21782a1e34c89d17e8a6902fe2940182.tar.gz rsyncshot-b5d7f4df21782a1e34c89d17e8a6902fe2940182.zip | |
Add Development section to README with Makefile targets
- Add make deps to Quick Start instructions
- Add Development section with all make targets table
- Move Testing as subsection under Development
| -rw-r--r-- | README.org | 28 |
1 files changed, 23 insertions, 5 deletions
@@ -18,7 +18,9 @@ sudo bash ./rsyncshot setup # Or clone and install git clone https://github.com/cjennings/rsyncshot -cd rsyncshot && sudo make install +cd rsyncshot +make deps # Install dependencies (auto-detects package manager) +sudo make install #+end_src After setup, edit =/etc/rsyncshot/config= to set your backup destination. @@ -173,11 +175,27 @@ sudo rm /var/log/rsyncshot.log # optional sudo crontab -e # remove rsyncshot entries #+end_src -* Testing +* Development + +Run =make= to see all available targets: + +| Target | Description | +|---------------+---------------------------------------------| +| help | Show all targets (default) | +| install | Install rsyncshot and configure cron | +| uninstall | Remove rsyncshot and config | +| deps | Install dependencies (auto-detects distro) | +| lint | Run shellcheck static analysis | +| check | Run lint + full test suite | +| test | Run full test suite | +| test-quick | Run quick tests (skip backup/cron) | +| test-verbose | Run tests with verbose output | + +** Testing An automated test suite is included in the =tests/= directory. -** Running Tests +*** Running Tests #+begin_src sh # Run all tests (requires sudo) @@ -190,7 +208,7 @@ sudo ./tests/test_rsyncshot.sh --quick sudo ./tests/test_rsyncshot.sh -v #+end_src -** Test Coverage +*** Test Coverage | Category | Tests | Description | |-------------+-------+------------------------------------------------------| @@ -200,7 +218,7 @@ sudo ./tests/test_rsyncshot.sh -v | Backup | 7 | Directory creation, file copying, rotation, retention, exclusions | | Cron | 3 | Cron job management, no duplicates, preserves existing jobs | -** Test Structure +*** Test Structure - =tests/test_rsyncshot.sh= - Main test runner - =tests/lib/test_helpers.sh= - Assertion functions and test environment setup |