Mercurial > wikked
comparison docs/pages/01_installation.md @ 382:3a61f45702cb
docs: Add documentation site.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Sun, 04 Oct 2015 08:02:43 -0700 |
| parents | |
| children | dcaa41b39c23 |
comparison
equal
deleted
inserted
replaced
| 381:d5511d832af3 | 382:3a61f45702cb |
|---|---|
| 1 --- | |
| 2 title: Installation | |
| 3 icon: cloud-download | |
| 4 --- | |
| 5 | |
| 6 ## From the package index | |
| 7 | |
| 8 You need [Python 3.4][py3] or later to use Wikked. Then, the easiest way to | |
| 9 install it is to use `pip`: | |
| 10 | |
| 11 pip install wikked | |
| 12 | |
| 13 If you want to use the very latest (and potentially broken) version: | |
| 14 | |
| 15 pip install git+ssh://git@github.com/ludovicchabant/Wikked.git#egg=Wikked | |
| 16 | |
| 17 Check that you have Wikked correctly installed by running: | |
| 18 | |
| 19 wk --help | |
| 20 | |
| 21 You should see Wikked's command line help. | |
| 22 | |
| 23 ## From source | |
| 24 | |
| 25 You can also use Wikked from source. It's recommended that you use `virtualenv` | |
| 26 for this (see the [documentation][venv] for more info). It would look something | |
| 27 like this: | |
| 28 | |
| 29 # Clone with either Mercurial or Git: | |
| 30 hg clone ssh://hg@bitbucket.org/ludovicchabant/wikked | |
| 31 git clone git@github.com:ludovicchabant/Wikked.git | |
| 32 | |
| 33 # Create and activate virtualenv, if you're on Bash | |
| 34 virtualenv venv | |
| 35 source venv/bin/activate | |
| 36 | |
| 37 # Install Wikked's requirements in venv | |
| 38 pip install -r requirements.txt | |
| 39 | |
| 40 python wk.py --help | |
| 41 | |
| 42 Just remember to activate your virtual environment every time you open a new | |
| 43 console. | |
| 44 | |
| 45 [py3]: https://www.python.org/downloads/ | |
| 46 [venv]: http://www.virtualenv.org/ | |
| 47 | |
| 48 |