Update README 🐒

This commit is contained in:
Dmitri Popov
2017-05-20 10:54:26 +02:00
parent d116876075
commit d0b123d5d7
2 changed files with 24 additions and 2 deletions

View File

@@ -12,10 +12,20 @@ Run the following command on your Raspberry Pi:
When prompted, reboot the Raspberry Pi.
By default, Little Backup Box is configured to back up storage cards. To make the script transfer files directly from the connected camera, run the `crontab -e` command on Raspberry Pi. Comment the following line by prepending *#* to it:
@reboot sudo /home/pi/little-backup-box/backup.sh > /home/pi/little-backup-box.log
Uncomment then the line below by removing *#*:
#@reboot sudo /home/pi/little-backup-box/gphoto-backup.sh > /home/pi/gphoto-backup.log
Save the changes.
## Usage
1. Boot the Raspberry Pi
2. Plug in the backup storage device
2. Plug in the backup storage device (or camera, if you configured Little Backup Box as described above)
3. Plug in the card reader and wait till the Raspberry Pi shuts down
**Note:** To differentiate between different storage cards, the backup script assigns a random 8-digit identifying number to each card (this number is stored in the *CARD_ID* file in the root of the card). The contents of the card is saved on the storage device in a folder with the identifying number as its name.
@@ -24,6 +34,18 @@ When prompted, reboot the Raspberry Pi.
Please report bugs and issues in the [Issues](https://github.com/dmpop/little-backup-box/issues) section.
## Contribute
If you've found a bug or have a suggestion for improvement, open an issue in the [Issues](https://github.com/dmpop/little-backup-box/issues) section.
To add a new feature or fix issues yourself, follow the following steps.
1. Fork the project's repository repository
2. Create a feature branch using the `git checkout -b new-feature` command
3. Add your new feature or fix bugs and run the `git commit -am 'Add a new feature'` command to commit changes
4. Push changes using the `git push origin new-feature` command
5. Submit a pull request
## Author
Dmitri Popov [dmpop@linux.com](mailto:dmpop@linux.com)