Mercurial > piecrust2

comparison docs/pages/getting-started.md @ 405:1970e7e3a18e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add the `--pre` flag to `pip install` while PieCrust is in beta.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 24 May 2015 18:35:57 -0700
parents 26e59f837558
children d9b1e5ad869f
comparison
equal deleted inserted replaced
404:27b10024f8d8 405:1970e7e3a18e
7 7
8 > If you're already an experienced cook, here's the rundown: 8 > If you're already an experienced cook, here's the rundown:
9 > 9 >
10 > virtualenv pcenv 10 > virtualenv pcenv
11 > <activate pcenv> 11 > <activate pcenv>
12 > pip install piecrust 12 > pip install piecrust --pre
13 > chef init mywebsite 13 > chef init mywebsite
14 > cd mywebsite 14 > cd mywebsite
15 > chef prepare post my-first-post 15 > chef prepare post my-first-post
16 > chef serve 16 > chef serve
17 > chef bake 17 > chef bake
35 ### Global installation 35 ### Global installation
36 36
37 Python 3 comes with a [package manager][2] called `pip`, with which you can install, 37 Python 3 comes with a [package manager][2] called `pip`, with which you can install,
38 update, and uninstall Python programs like PieCrust. Just run: 38 update, and uninstall Python programs like PieCrust. Just run:
39 39
40 pip install piecrust 40 pip install piecrust --pre
41 41
42 This will install PieCrust globally on your system. You may want to install it 42 This will install PieCrust globally on your system. You may want to install it
43 using a *virtual environment* instead, though. See the next section for that. 43 using a *virtual environment* instead, though. See the next section for that.
44 44
45 > #### Permission Errors 45 > #### Permission Errors
46 > 46 >
47 > If you get some permission errors, you may have to run that command as an 47 > If you get some permission errors, you may have to run that command as an
48 > administrator. That would be `sudo pip install piecrust` on MacOSX and Linux, or 48 > administrator. That would be `sudo pip install piecrust --pre` on MacOSX and
49 > running the Command Prompt as an Administrator on Windows. 49 > Linux, or running the Command Prompt as an Administrator on Windows.
50 50
51 You should now have PieCrust installed! You can check that it works by typing: 51 You should now have PieCrust installed! You can check that it works by typing:
52 52
53 chef --version 53 chef --version
54 54
65 which you don't have administrator access. 65 which you don't have administrator access.
66 66
67 Thankfully, `pip` supports a whole variety of scenarios, and [another 67 Thankfully, `pip` supports a whole variety of scenarios, and [another
68 utility][3], called `virtualenv` enables even more of them. 68 utility][3], called `virtualenv` enables even more of them.
69 69
70 * If you don't have it yet, install `virtualenv` with `pip install 70 * If you don't have it yet, install `virtualenv` with `pip install virtualenv`,
71 virtualenv`, or check with your administrators to have it. Most web hosts 71 or check with your administrators to have it. Most web hosts provide it.
72 provide it.
73 * Run `virtualenv pcenv`. This will create a directory called `pcenv` that 72 * Run `virtualenv pcenv`. This will create a directory called `pcenv` that
74 contains a whole new Python environment, separate from your system's Python 73 contains a whole new Python environment, separate from your system's Python
75 environment. 74 environment.
76 * Activate that environment with `sh pcenv/bin/activate.sh` (on Linux or 75 * Activate that environment with `sh pcenv/bin/activate.sh` (on Linux or MacOSX)
77 MacOSX) or `pcenv\Scripts\activate` (on Windows). The new environment will 76 or `pcenv\Scripts\activate` (on Windows). The new environment will now be
78 now be active for as long as your current command prompt is active. 77 active for as long as your current command prompt is active.
79 * Now install PieCrust with `pip install piecrust`. This will install it in 78 * Now install PieCrust with `pip install piecrust --pre`. This will install it
80 that environment, leaving your system's Python clean of any of PieCrust's 79 in that environment, leaving your system's Python clean of any of PieCrust's
81 dependencies. 80 dependencies.
82 81
83 82
84 ## Create an empty website 83 ## Create an empty website
85 84