From 4d7880a9e00cb02adc0a109aacfbd8f200bdbf90 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sun, 16 Apr 2017 11:21:32 +0300 Subject: [PATCH] Add installation instructions --- docs/index.rst | 1 + docs/install.rst | 39 +++++++++++++++++++++++++++++++++++++++ docs/news.rst | 2 ++ 3 files changed, 42 insertions(+) create mode 100644 docs/install.rst diff --git a/docs/index.rst b/docs/index.rst index a438400..f339591 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Remove old files. It's a portable replacement for :maxdepth: 2 :caption: Contents: + install news .. highlight:: none diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..b38ccc6 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,39 @@ +Installation using pip +====================== + +System-wide +----------- + +:: + + sudo pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' remove-old-files + +User mode +--------- + +:: + + pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user remove-old-files + +For Python 2.6 the command is easy_install. + +Installation from sources +========================= + +To install the library from sources system-wide run run the following +command: + +:: + + sudo python setup.py install -O2 + +If you don't want to install it system-wide you can install it in your +home directory; run run the following command: + +:: + + python setup.py install -O2 --user + +Option '--user' installs script remove-old-files.py into $HOME/.local/bin; +add the directory to your $PATH or move the script to a directory in your +$PATH. diff --git a/docs/news.rst b/docs/news.rst index 3d3375d..45a3f5a 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -6,6 +6,8 @@ News * Remove empty directories. +* Add installation instructions. + 0.0.1 (2017-04-16) ------------------ -- 2.39.2