From 7525f6558c5891e43f228b1e37f9c71d7a84cdf9 Mon Sep 17 00:00:00 2001 From: Elisa Sohier Date: Thu, 1 Aug 2019 17:07:31 +0200 Subject: Readme: install --- README.mkd | 11 +++++++++++ 1 file changed, 11 insertions(+) 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) -- cgit v1.2.3