piecrust2: INSTALL.rst annotate

annotate INSTALL.rst @ 1045:2f39ffa601a9

serve: Re-enable baking assets when running the server.

author	Ludovic Chabant <ludovic@chabant.com>
date	Tue, 23 Jan 2018 08:54:27 -0800
parents	de09d41bae23
children

rev	line source
160 de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 From the package server
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 -----------------------
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 The simplest way to install PieCrust is to install it from PyPi_, the Python
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7 package index:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	8
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11 easy_install piecrust
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13 or:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17 pip install piecrust
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19 You'll need to have Python3 installed (support for Python2 may come later).
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	20
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21 .. _Pypi: https://pypi.python.org/pypi
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24 From a tarball
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25 --------------
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27 You can also install PieCrust using a snapshot of the code. See the `download
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28 page`_ where you can either get the `very latest`_, or any of the previous
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	29 official releases. Then you can point ``pip`` to the tarball (either one you
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	30 previously downloaded, or directly from BitBucket):
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	31
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	32 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	33
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	34 pip install https://bitbucket.org/ludovicchabant/piecrust2/get/tip.tar.gz
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	36 You'll need to have Python3 installed (support for Python2 may come later).
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	37
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38 .. _download page: https://bitbucket.org/ludovicchabant/piecrust2/downloads
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	39 .. _very latest: https://bitbucket.org/ludovicchabant/piecrust2/get/tip.tar.gz
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 Using a virtual environment
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43 ---------------------------
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	45 This method is not as simple as the previous ones, but is probably the
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46 recommended one. All the methods so far will install PieCrust globally on your
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47 system, which is fine if you're installing it on your own computer, but may
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 cause problems later. For instance, PieCrust may have some dependencies in
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	49 common with some other Python programs you have installed, and things may break
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 when you update one of them. Alternatively, you may just want to install
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 PieCrust on a computer you don't fully control, like in a shared hosting
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 environment. Or maybe you just like things to be tidy.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	53
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54 For this you'll need ``virtualenv``. A virtual environment is simply a folder
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	55 on your computer that contains a portable, fully functional Python environment
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	56 -- one that would, in this case, contain a certain version of PieCrust, along
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57 with all its dependencies, separate from your global Python installation.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	58
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	59 You'll also need to have Python3 installed (support for Python2 may come later).
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	60
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	61 On Mac/Linux:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	62
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	63 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 virtualenv -p python3 venv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 . venv/bin/activate
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	67 pip install piecrust
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	68
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	69 On Windows:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	70
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	71 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	72
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	73 virtualenv -p python3 venv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	74 venv\Scripts\activate
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	75 pip install piecrust
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	76
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	77
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	78 If the first command fails, chances are that you don't have ``virtualenv``
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	79 installed. You should be able to install it with:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	80
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	81 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	82
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	83 pip install virtualenv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	84
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	85 Some Linux/UNIX-based systems have it in their package manager, so if that
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	86 doesn't work you can try:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	87
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	88 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	89
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 apt-get install virtualenv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	92 If both fail, you may have to get it "by hand", by `downloading the code from
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	93 PyPi`_, extracting the archive, and running it from there. For instance, on
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94 Linux/UNIX:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	95
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	96 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98 wget http://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.11.6.tar.gz
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99 tar xzf virtualenv-1.11.6.tar.gz
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 python virtualenv-1.11.6/virtualenv.py venv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102 From there, you can continue with activating the virtual environment and
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103 install PieCrust in it, as shown previously.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	105
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106 .. _downloading the code from PyPi: https://pypi.python.org/pypi/virtualenv#downloads
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	109 From source
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	110 -----------
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	111
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	112 If you intend to stay close to the development branch of PieCrust, or if you
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	113 want to contribute to the project with some coding of you own, you may want to
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	114 clone the repository locally and run PieCrust from there.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	115
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	116 In order to install PieCrust's dependencies, it's recommended to use a virtual
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	117 environment (see above). If you're familiar with Python development, you should
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	118 know all about this already. Also, so far, PieCrust is a Python3-only project
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	119 (support for Python2 may come later) so make sure you have that installed.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 Using Mercurial:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	123 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	125 hg clone https://bitbucket.org/ludovicchabant/piecrust2
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	127 Using Git:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	129 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	131 git clone https://github.com/ludovicchabant/PieCrust2.git
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	132
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134 Then create the virtual environment and install dependencies.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136 On Mac/Linux:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	139
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 cd <your clone of PieCrust2>
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141 virtualenv -p pyton3 venv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 . venv/bin/activate
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 pip install -r requirements.txt
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 On Windows:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 cd <your clone of PieCrust2>
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 virtualenv -p python3 venv
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	151 venv\Scripts\activate
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	152 pip install -r requirements.txt
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154 To run PieCrust, run ``bin/chef`` (on Mac/Linux) or ``bin\chef.cmd`` (on
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155 Windows), which is basically the same as running ``python chef.py``. Make sure
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	156 that you're running this with the virtual environment active.
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	157
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158 When you want to update PieCrust, do ``hg pull -u`` or ``git pull``, depending
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	159 on which source control system you used to clone the repository, and then
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	160 update any dependencies that may have changed:
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	161
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	162 ::
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	163
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	164 pip install -r requirements.txt -U
de09d41bae23 Moved all installation instructions to a new `INSTALL` file. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	165

Mercurial > piecrust2

annotate INSTALL.rst @ 1045:2f39ffa601a9