summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElisa Sohier <elisa.sohier@art-software.fr>2019-08-01 17:07:31 +0200
committerElisa Sohier <elisa.sohier@art-software.fr>2019-08-01 17:07:31 +0200
commit7525f6558c5891e43f228b1e37f9c71d7a84cdf9 (patch)
tree3b4495479f6fc8590cca1b205d35f7e0a70a08aa
parent93264fc43715b0853477b9a6250f749c20480fa7 (diff)
Readme: install
-rw-r--r--README.mkd11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.mkd b/README.mkd
index ea06902..07affcb 100644
--- a/README.mkd
+++ b/README.mkd
@@ -7,6 +7,17 @@ AutoSync is a tiny utility to synchronize data between computers.
- rsync
## How-to ##
+### Install me ###
+You can install this directly as a python package using the `pip3` command, like this:
+```bash
+pip3 install git+https://git.art-software.fr/electron/AutoSync.git
+```
+
+You can prepend the url with --user to make it install into your user path (~/.local/bin for the binary and ~/.local/lib/python3.x/site-packages/ for the rest)
+If you wish to install system-wide, think about running pip3 **as root**.
+
+Add --upgrade to upgrade the package when needed.
+
### Get help ###
You can invoke AutoSync (we'll write asc from here, it's shorter :) ) with *no* option to let it list for you all that you can do with it
(or you can see below)