Skip to content

Commit

Permalink
README.md: Update installation and usage
Browse files Browse the repository at this point in the history
Show how to install and use the install userstorage command line tool.
  • Loading branch information
nirs committed Jul 17, 2019
1 parent efcd266 commit b39b880
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ quickly as yourself directly from your editor.

## Installing

Currently the only way to install this is cloning the repo and
installing the package manually. We will make this available via pip
soon.
Use pip:

python3 -m pip install --user userstorage

Use python2 if you need to run on a distribution without python3.

## Creating configuration file

Expand Down Expand Up @@ -55,14 +56,14 @@ project.

To create the storage described in example_config.py, run:

python -m userstorage create example_config.py
userstorage create example_config.py

This can be run once when creating a development environment, and must
be run again after rebooting the host.

If you want to delete the storage, run:

python -m userstorage delete example_config.py
userstorage delete example_config.py

There is no need to delete the storage normally. The loop devices are
backed up by sparse files and do not consume much resources.
Expand Down Expand Up @@ -145,12 +146,12 @@ pip.

Before running the tests, create the example storage:

python -m userstorage create example_config.py
python3 -m userstorage create example_config.py

To run the tests:

tox

If you want to change storage layout, best delete the example storage:

python -m userstorage delete example_config.py
python3 -m userstorage delete example_config.py

0 comments on commit b39b880

Please sign in to comment.