Skip to content
This repository
Newer
Older
100644 102 lines (73 sloc) 2.76 kb
b2e500ba » Carl Masak
2008-08-15 further slight improvements to README
1 November
2 ========
77521f2b »
2008-08-15 Added README file
3
4 November Copyright (C) 2008, Carl Mäsak & Johan Viklund
5
6 LICENSE INFORMATION
7 -------------------
8
7d7f3001 » Carl Masak
2008-08-15 tweaked README, added LICENSE
9 November is free software; you can redistribute it and/or modify it under the
10 terms of the Artistic License 2.0. (Note that, unlike the Artistic License
11 1.0, version 2.0 is GPL compatible by itself, hence there is no benefit to
12 having an Artistic 2.0 / GPL disjunction.)
77521f2b »
2008-08-15 Added README file
13
7d7f3001 » Carl Masak
2008-08-15 tweaked README, added LICENSE
14 CONTRIBUTING
15 ------------
77521f2b »
2008-08-15 Added README file
16
7d7f3001 » Carl Masak
2008-08-15 tweaked README, added LICENSE
17 We'll hand out commit bits liberally. If you want to contribute, create an
18 account on github.org and send your github handle to Johan
51be8d71 » masak
2008-09-21 [README] referred to docs/COMMITTERS from README, so that people will…
19 (johan.viklund@gmail.com). Patches are ok too, if you prefer those. See
20 docs/COMMITTERS if these thoughts intrigue you.
77521f2b »
2008-08-15 Added README file
21
22 PREREQUISITES
23 -------------
24
25 You need Parrot and Rakudo. Check it out from the Parrot svn repository and
26 follow instructions there. See instructions on the parrot site:
27
28 <http://www.parrotcode.org/>
29
30 REPOSITORY LAYOUT
31 -----------------
32
fa9925fe » Carl Masak
2008-08-15 some typos in README
33 /
b2e500ba » Carl Masak
2008-08-15 further slight improvements to README
34
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
35 ├─p6w/ Perl 6 wiki implementation
b2e500ba » Carl Masak
2008-08-15 further slight improvements to README
36
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
37 ├─p5w/ Perl 5 reference implementation
38
39 ├─docs/ Developer documentation for both p5w and p6w
40
41 ├─talks/ Presentations and links to videos about November
42
43 └─logotype/ Graphics files for the November logotype
77521f2b »
2008-08-15 Added README file
44
7d7f3001 » Carl Masak
2008-08-15 tweaked README, added LICENSE
45 RUNNING NOVEMBER
46 ----------------
77521f2b »
2008-08-15 Added README file
47
431d2532 »
2008-09-02 [README] Now reflects our current workflow (with Makefile.PL)
48 $ perl Makefile.PL
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
49 $ make # not required, and doesn't currently work
9756cc08 »
2008-08-20 [p6w] Added a Makefile for constructing .pir targets (giving a 17-fold
50
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
51 * Running November on the command line
77521f2b »
2008-08-15 Added README file
52
53 This will generate the Main_Page on STDOUT:
54
55 $ ./test_wiki.sh
56
601e8b77 » masak
2008-08-24 [p6w] removed subst.patch and the mention of it in README. moritz++
57 To specify which page to view you need to specify the GET paramters on the
58 command line, as follows:
77521f2b »
2008-08-15 Added README file
59
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
60 $ ./test_wiki.sh
77521f2b »
2008-08-15 Added README file
61 $ ./test_wiki.sh 'action=view&page=Main_Page'
62
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
63 The above two commands are equivalent, since 'view' is the default action,
64 and 'Main_Page' is the default page for the 'view' action.
77521f2b »
2008-08-15 Added README file
65
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
66 The other actions we have so far are 'edit', 'log_in', 'log_out' and
67 'recent_changes'.
77521f2b »
2008-08-15 Added README file
68
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
69 * Running November through a web server
77521f2b »
2008-08-15 Added README file
70
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
71 We have only tested the following on the Apache web server. You need to put
72 these files and directories in the 'cgi-bin' directory of Apache:
77521f2b »
2008-08-15 Added README file
73
74 wiki.sh
75 wiki
76 skin/
431d2532 »
2008-09-02 [README] Now reflects our current workflow (with Makefile.PL)
77 HTML/
77521f2b »
2008-08-15 Added README file
78 CGI.pm
79 Impatience.pm
431d2532 »
2008-09-02 [README] Now reflects our current workflow (with Makefile.PL)
80 Wiki.pm
77521f2b »
2008-08-15 Added README file
81 data/
82
7dc9a487 » masak
2008-10-25 [README] various fixes and updates
83 If you have compiled November you can copy the .pir files instead of the .pm
84 files. Make sure that the files and directories below data/ are readable
85 and writable by the web server. Also, if you want a styled wiki you need to
431d2532 »
2008-09-02 [README] Now reflects our current workflow (with Makefile.PL)
86 copy the following files into the root of your web server:
77521f2b »
2008-08-15 Added README file
87
88 skin/spartan.css
89 skin/november-logo.png
90
7d7f3001 » Carl Masak
2008-08-15 tweaked README, added LICENSE
91 Seriously. (This will change, though.)
77521f2b »
2008-08-15 Added README file
92
fa9925fe » Carl Masak
2008-08-15 some typos in README
93 After this, you can direct your browser to the wiki. The URL will
94 look something like this:
77521f2b »
2008-08-15 Added README file
95
96 http://localhost/cgi-bin/wiki.sh
97
98 CONTACT
99 -------
100
fb0ef6dc »
2008-09-03 Added google group email to README
101 Google group: november-wiki@googlegroups.com
677624bb » masak
2008-09-03 [p6w] removed Carl/Johan contact details, added IRC channel
102 IRC channel: #november-wiki over at irc.freenode.org
Something went wrong with that request. Please try again.