doc/source/user/00_install.rst

   1 Installation
   2 ============
   3
   4 \*nix distributions
   5 -------------------
   6
   7 Use your package manager, there are packages for Debian (and probably derivatives) and Arch via AUR.
   8
   9
  10 Python virtualenv
  11 -----------------
  12
  13 .. code:: bash
  14
  15     # create venv
  16     python -m venv mpd_sima-venv
  17     # activate
  18     . ./mpd_sima-venv/bin/activate
  19     # Install the application
  20     pip install MPD_sima
  21     # Print help message
  22     mpd-sima --help
  23
  24 From Source
  25 -----------
  26
  27 Virtualenv installation from source:
  28
  29 Run ``python ./vinstall.py`` from the source to generate the python virtualenv and install requirements.
  30
  31 It will setup a virtualenv within a "venv" directory (same level as vinstall.py file). It should also write a shell wrapper to run mpd-sima within the virtualenv.
  32
  33
  34 .. code:: bash
  35
  36     # Clone master branch
  37     git clone -b master git@gitlab.com:kaliko/sima.git
  38     # setup virtualenv
  39     python ./vinstall.py
  40     ./vmpd-sima --help
  41
  42 To restart from scratch or pull latest changes
  43
  44 .. code:: bash
  45
  46     # Get into the local git repo (here sima directory)
  47     cd sima
  48     # Remove virtualenv
  49     rm -rf ./venv
  50     # Fetch and merge latest changes
  51     git pull
  52     # setup virtualenv
  53     python ./vinstall.py
  54     ./vmpd-sima --help
  55
  56
  57 .. vim: spell spelllang=en