Mercurial > piecrust2
changeset 405:1970e7e3a18e
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 | 27b10024f8d8 |
| children | 9caaf78a17db 375301e024b5 |
| files | docs/pages/_index.md docs/pages/getting-started.md |
| diffstat | 2 files changed, 12 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/pages/_index.md Sun May 24 18:15:22 2015 -0700 +++ b/docs/pages/_index.md Sun May 24 18:35:57 2015 -0700 @@ -97,7 +97,7 @@ virtualenv pcenv <activate pcenv> - pip install piecrust + pip install piecrust --pre chef init mynewwebsite cd mynewwebsite chef prepare post my-first-post
--- a/docs/pages/getting-started.md Sun May 24 18:15:22 2015 -0700 +++ b/docs/pages/getting-started.md Sun May 24 18:35:57 2015 -0700 @@ -9,7 +9,7 @@ > > virtualenv pcenv > <activate pcenv> -> pip install piecrust +> pip install piecrust --pre > chef init mywebsite > cd mywebsite > chef prepare post my-first-post @@ -37,7 +37,7 @@ Python 3 comes with a [package manager][2] called `pip`, with which you can install, update, and uninstall Python programs like PieCrust. Just run: - pip install piecrust + pip install piecrust --pre This will install PieCrust globally on your system. You may want to install it using a *virtual environment* instead, though. See the next section for that. @@ -45,8 +45,8 @@ > #### Permission Errors > > If you get some permission errors, you may have to run that command as an -> administrator. That would be `sudo pip install piecrust` on MacOSX and Linux, or -> running the Command Prompt as an Administrator on Windows. +> administrator. That would be `sudo pip install piecrust --pre` on MacOSX and +> Linux, or running the Command Prompt as an Administrator on Windows. You should now have PieCrust installed! You can check that it works by typing: @@ -67,17 +67,16 @@ Thankfully, `pip` supports a whole variety of scenarios, and [another utility][3], called `virtualenv` enables even more of them. -* If you don't have it yet, install `virtualenv` with `pip install - virtualenv`, or check with your administrators to have it. Most web hosts - provide it. +* If you don't have it yet, install `virtualenv` with `pip install virtualenv`, + or check with your administrators to have it. Most web hosts provide it. * Run `virtualenv pcenv`. This will create a directory called `pcenv` that contains a whole new Python environment, separate from your system's Python environment. -* Activate that environment with `sh pcenv/bin/activate.sh` (on Linux or - MacOSX) or `pcenv\Scripts\activate` (on Windows). The new environment will - now be active for as long as your current command prompt is active. -* Now install PieCrust with `pip install piecrust`. This will install it in - that environment, leaving your system's Python clean of any of PieCrust's +* Activate that environment with `sh pcenv/bin/activate.sh` (on Linux or MacOSX) + or `pcenv\Scripts\activate` (on Windows). The new environment will now be + active for as long as your current command prompt is active. +* Now install PieCrust with `pip install piecrust --pre`. This will install it + in that environment, leaving your system's Python clean of any of PieCrust's dependencies.