Mercurial > agora

annotate README @ 24:2e7226e90157

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Many fixes. See detailed description. - Style errors - Writer proper 404 and 500 templates - Make login page redirect back to page being viewed (still buggy?) - Provide a brief blurb about Agora - Use tables for registration and login forms (need to be styled) - Fix typos, grammatical errors. - Don't use .djhtml extension for some templates
author Jordi Gutiérrez Hermoso <jordigh@gmail.com>
date Mon, 28 Jun 2010 03:00:01 -0500
parents 41d05dcaf93a
children 9f17312f3914
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
1 Agora Octave is (or will be) a Django-based website for rapid
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
2 collaboroation related to GNU Octave. It is released under the terms
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
3 of the Affero General Public License version 3 as published by the
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
4 Free Software Foundation, or at your option, any later version.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
5
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
6 Quickstart for personal debugging:
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
7
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
8 1) Install Django, Python, mercurial, SQLite3. On a Unix-based
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
9 system, Python is probably already installed.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
10
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
11 2) Clone this repository
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
12
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
13 3) In the cloned repository, copy "settings-example.py" to
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
14 "settings.py" (advanced users: modify this to suit your needs).
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
15
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
16 4) Now run
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
17
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
18 $ python manage.py syncbd #Will create an empty database
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
19 #(by default: sqlite3)
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
20
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
21 $ python manage.py runserver #Run a development webserver on port 8000
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
22
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
23 5) Point a browser to http://localhost:8000
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
24
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
25 6) Submit patches. ;-)
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
26
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
27 Here's our TODO. At the moment, almost none of this is done. "I" in
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
28 the text below indicates "Jordi".
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
29
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
30 -- Users can upload bundles of code.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
31
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
32 -- Bundles clearly indicate which free license they are using. I'm
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
33 thinking that it's reasonable to restrict allowable licenses to
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
34 GPL-compatibility. This is not a stringent requirement, and it
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
35 would simplify distribution with Octave. For the moment I'm
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
36 considering that this might be relaxed and any license approved
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
37 by the OSI or FSF should be ok.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
38
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
39 -- Additionally, there's a place to post quick snippets. They'll
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
40 be under a default free license that the user indicates in
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
41 their preferences. Usually only single bits of code go in
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
42 there. Responding with more snippets will be facilitated.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
43
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
44 -- I'm thinking that optionally, I can setup bundles to also
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
45 create an hg repo if the uploader requests it, or existing hg
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
46 repos can be imported.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
47
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
48 -- When viewing a user's bundle, the bundle as a whole can be
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
49 ranked and commented upon by logged in users. The contents of
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
50 the bundle can also be browsed from the web without needing to
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
51 download the whole bundle.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
52
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
53 -- Logging in is required only to contribute to the site with
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
54 code, comments, ranking code. Everything else is public to
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
55 anyone.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
56
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
57 -- Users are encouraged but not required to provide real names.
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
58
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
59 -- Bundles that are somehow deemed to be of high quality can
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
60 easily be pushed to Octave-forge (i.e. they've been "forged",
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
61 tempered, tested and tried).
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
62
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
63 -- A user's landing page will indicate which bundles and snippets
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
64 this user has uploaded as well as whatever personal information
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
65 the user would like to provid.e
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
66
41d05dcaf93a Add a README
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
diff changeset
67 This README itself also admits patches.