Mercurial > piecrust2

annotate README.rst @ 147:ab6e7e0e9d44

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Pass date information to routing when building URLs. This is so that URLs with dates in them can be built even when the date information is not coming from the source metadata, but from the page's config.
author Ludovic Chabant <ludovic@chabant.com>
date Sat, 29 Nov 2014 21:00:44 -0800
parents 742009d964ef
children de09d41bae23
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 PieCrust is a static website generator and lightweight CMS that's all managed
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 with text files. No complex setup, databases, or administrative panels.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 Simple, beautiful, and yummy.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 For more information, along with the complete documentation, visit `the
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 official website`_.
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9 .. _the official website: http://bolt80.com/piecrust/
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 Quickstart
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
13 ==========
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
15 If you want to quickly give it a spin:
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 ::
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
19 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
20 chef init mywebsite
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21 cd mywebsite
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
22 chef serve
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
24 It should create a new empty site in a ``mywebsite`` folder, and start a small
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
25 web server to preview it. You can then point your browser to ``localhost:8080``
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
26 to see the default home page.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
28 Use ``chef prepare page`` and ``chef prepare post`` to create pages and posts,
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
29 and edit those in your favorite text editor.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
30
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
31 When you're happy, run ``chef bake`` to generate the final static website,
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
32 which you'll find in ``_counter``. At this point you can upload the contents of
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
33 ``_counter`` to your server.
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 Changes
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 =======
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
39 Check out the ``CHANGELOG`` file for new features, bug fixes and breaking changes.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
40
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
41
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
42 Installation
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
43 ============
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
44
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
45 From the package server
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
46 -----------------------
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
47
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
48 The simplest way to install PieCrust is to install it from PyPi_, the Python
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
49 package index:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
50
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
51 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
52
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
53 easy_install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
54
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
55 or:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
56
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
57 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
58
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
59 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
60
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
61 .. _Pypi: https://pypi.python.org/pypi
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
62
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
63
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
64 From a tarball
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
65 --------------
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
66
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
67 You can also install PieCrust using a snapshot of the code. See the `download
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
68 page`_ where you can either get the `very latest`_, or any of the previous
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
69 official releases. Then you can point ``pip`` to the tarball (either one you
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
70 previously downloaded, or directly from BitBucket):
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
71
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
72 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
73
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
74 pip install https://bitbucket.org/ludovicchabant/piecrust2/get/tip.tar.gz
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
75
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
76
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
77 .. _download page: https://bitbucket.org/ludovicchabant/piecrust2/downloads
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
78 .. _very latest: https://bitbucket.org/ludovicchabant/piecrust2/get/tip.tar.gz
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
79
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
80
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
81 Using a virtual environment
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
82 ---------------------------
9
8f7ba2c95025 Add packaging and related files.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
83
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
84 This method is not as simple as the previous ones, but is probably the
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
85 recommended one. All the methods so far will install PieCrust globally on your
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
86 system, which is fine if you're installing it on your own computer, but may
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
87 cause problems later. For instance, PieCrust may have some dependencies in
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
88 common with some other Python programs you have installed, and things may break
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
89 when you update one of them. Alternatively, you may just want to install
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
90 PieCrust on a computer you don't fully control, like in a shared hosting
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
91 environment. Or maybe you just like things to be tidy.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
92
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
93 For this you'll need ``virtualenv``. A virtual environment is simply a folder
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
94 on your computer that contains a portable, fully functional Python environment
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
95 -- one that would, in this case, contain a certain version of PieCrust, along
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
96 with all its dependencies, separate from your global Python installation.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
97
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
98 On Mac/Linux:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
99
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
100 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
101
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
102 virtualenv venv
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
103 . venv/bin/activate
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
104 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
105
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
106 On Windows:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
107
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
108 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
109
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
110 virtualenv venv
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
111 venv\Scripts\activate
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
112 pip install piecrust
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
113
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
114
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
115 If the first command fails, chances are that you don't have ``virtualenv``
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
116 installed. You should be able to install it with:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
117
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
118 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
119
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
120 pip install virtualenv
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
121
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
122 Some Linux/UNIX-based systems have it in their package manager, so if that
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
123 doesn't work you can try:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
124
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
125 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
126
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
127 apt-get install virtualenv
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
128
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
129 If both fail, you may have to get it "by hand", by `downloading the code from
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
130 PyPi`_, extracting the archive, and running it from there. For instance, on
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
131 Linux/UNIX:
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
132
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
133 ::
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
134
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
135 wget http://pypi.python.org/packages/source/v/virtualenv/virtualenv-1.11.6.tar.gz
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
136 tar xzf virtualenv-1.11.6.tar.gz
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
137 python virtualenv-1.11.6/virtualenv.py venv
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
138
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
139 From there, you can continue with activating the virtual environment and
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
140 install PieCrust in it, as shown previously.
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
141
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
142
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
143 .. _downloading the code from PyPi: https://pypi.python.org/pypi/virtualenv#downloads
742009d964ef More installation information in the README file.
Ludovic Chabant <ludovic@chabant.com>
parents: 9
diff changeset
144