Mercurial > wikked

annotate README.md @ 472:dbe22d170cf7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
web: Don't offer to create a missing page when in a read-only endpoint.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 08 Oct 2018 23:46:08 -0700
parents 93a2f7c86059
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1
209
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
2 .__ __ __ .___
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
3 __ _ _|__| | _| | __ ____ __| _/
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
4 \ \/ \/ / | |/ / |/ // __ \ / __ |
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
5 \ /| | <| <\ ___// /_/ |
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
6 \/\_/ |__|__|_ \__|_ \\___ >____ |
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
7 \/ \/ \/ \/
9e771e0b76f5 ASCII art!
Ludovic Chabant <ludovic@chabant.com>
parents: 166
diff changeset
8
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 Wikked is a wiki engine entirely managed with text files stored in a revision
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 control system like Mercurial or Git.
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
13 The documentation is available on the [official website][1].
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
14
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
15 [1]: http://bolt80.com/wikked/
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
16
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
18 ## Quickstart
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
20 You need Python 3.4 or later. Then, you install Wikked the usual way:
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
21
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
22 pip install wikked
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
23
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
24 Create a new wiki:
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
25
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
26 wk init mywiki
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
28 Run it:
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
30 cd mywiki
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
31 wk runserver
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32
384
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
33 Navigate to `http://localhost:5000`. If you see the default main page, every
93a2f7c86059 cm: Simplify README file, add link to official website.
Ludovic Chabant <ludovic@chabant.com>
parents: 209
diff changeset
34 works fine! Otherwise, something went wrong.
166
a7aa5c86350e Added a short `README` file.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35