Skip to content

Commit

Permalink
Update README.creole
Browse files Browse the repository at this point in the history
  • Loading branch information
jedie committed Feb 3, 2016
1 parent 3d3fa3a commit a500efc
Showing 1 changed file with 46 additions and 19 deletions.
65 changes: 46 additions & 19 deletions README.creole
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,19 @@ This will create deduplication backups like this:
~/PyHardLinkBackups
└── documents
├── 2016-01-07-085247
│ ├── phlb_config.ini
│ ├── spreadsheet.ods
│ ├── brief.odt
│ └── important_files.ext
└── 2016-01-07-102310
├── phlb_config.ini
├── spreadsheet.ods
├── brief.odt
└── important_files.ext
}}}


== Try out:

=== on Windows:
== Install under Windows:

# install Python 3: https://www.python.org/downloads/
# Download the file [[https://raw.githubusercontent.com/jedie/PyHardLinkBackup/master/boot_pyhardlinkbackup.cmd|boot_pyhardlinkbackup.cmd]]
Expand All @@ -74,7 +74,7 @@ To start the django webserver, call:
=== on Linux:
== Install under Linux:

# Download the file [[https://raw.githubusercontent.com/jedie/PyHardLinkBackup/master/boot_pyhardlinkbackup.sh|boot_pyhardlinkbackup.sh]]
# call **boot_pyhardlinkbackup.sh**
Expand Down Expand Up @@ -104,7 +104,7 @@ To start the django webserver, call:
==== start backup run
== start backup run

To start a backup run, use this helper script:

Expand All @@ -130,6 +130,7 @@ e.g.: Current working directoy is: **/foo/bar/my_files/** then the search path w
* /PyHardLinkBackup.ini
* ~/PyHardLinkBackup.ini //The user home directory under Windows/Linix//
=== Create / edit default .ini

You can just open the editor with the user directory .ini file with:
Expand All @@ -139,6 +140,7 @@ You can just open the editor with the user directory .ini file with:

The defaults are stored here: [[https://github.com/jedie/PyHardLinkBackup/blob/master/PyHardLinkBackup/phlb/config_defaults.ini|/phlb/config_defaults.ini]]


=== Exclude files/folders from backup:

There are two ways to exclude files/folders from your backup.
Expand All @@ -159,20 +161,13 @@ The **SKIP_DIRS** is used in the first step.
The **SKIP_PATTERNS** is used the the second step.


== run unittests
{{{
$ cd PyHardLinkBackup/
~/PyHardLinkBackup $ source bin/activate
(PyHardLinkBackup) ~/PyHardLinkBackup $ manage test
}}}



== some notes

=== What is 'phlb' ?!?
=== What is 'phlb' and 'manage' ?!?

The **phlb** executable cli.

the **phlb** executable is the similar to django **manage.py**, but it always
The **manage** is similar to a normal django **manage.py**, but it always
used the PyHardLinkBackup settings.

=== Why in hell do you use django?!?
Expand All @@ -181,13 +176,45 @@ used the PyHardLinkBackup settings.
=== How to go into the django admin?

Just start:

* windows: {{{phlb_run_django_webserver.cmd}}}
* linux: {{{phlb_run_django_webserver.sh}}}
And then just request 'localhost'
(Note: **--noreload** is needed under windows with venv!)


== run unittests

Just start: {{{phlb_run_tests.cmd}}} / {{{phlb_run_tests.sh}}} or do this:
{{{
$ cd PyHardLinkBackup/
~/PyHardLinkBackup $ source bin/activate
(PyHardLinkBackup) ~/PyHardLinkBackup $ phlb runserver
(PyHardLinkBackup) ~/PyHardLinkBackup $ manage test
}}}


== the cli

{{{
$ cd PyHardLinkBackup/
~/PyHardLinkBackup $ source bin/activate
(PyHardLinkBackup) ~/PyHardLinkBackup $ phlb --help
Usage: phlb [OPTIONS] COMMAND [ARGS]...
PyHardLinkBackup
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
backup Start a Backup run
config Create/edit .ini config file
helper link helper files to given path
verify Verify a existing backup
}}}
And then just request 'localhost'
(Note: **--noreload** is needed under windows with venv!)


=== Windows Development
Expand Down

0 comments on commit a500efc

Please sign in to comment.