Mercurial > agora-palash
annotate README @ 56:9659998da890
Update TODO in README with the work that's been done
| author | Jordi Gutiérrez Hermoso <jordigh@gmail.com> |
|---|---|
| date | Mon, 07 Feb 2011 13:17:51 -0600 |
| parents | fd4c5b26b67a |
| children | 9c1e26cc80e3 |
| rev | line source |
|---|---|
| 19 | 1 Agora Octave is (or will be) a Django-based website for rapid |
|
28
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
2 collaboration related to GNU Octave. It is released under the terms of |
|
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
3 the Affero General Public License version 3 as published by the Free |
|
43
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
4 Software Foundation, or at your option, any later version. Agora also |
|
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
5 includes other software under a different BSD-like license. For |
|
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
6 details consult LICENSE. |
| 19 | 7 |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
8 Required external libraries: |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
9 |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
10 - Django registration |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
11 (http://bitbucket.org/ubernostrum/django-registration/) |
|
51
fd4c5b26b67a
Mention in README that pygments is also a required external lib
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
50
diff
changeset
|
12 - Pygments |
|
fd4c5b26b67a
Mention in README that pygments is also a required external lib
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
50
diff
changeset
|
13 (http://pygments.org/) |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
14 |
| 19 | 15 Quickstart for personal debugging: |
| 16 | |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
17 1) Install Django 1.2 or higher, Python 2.5 or higher, the |
| 50 | 18 external libraries, and probably any version of mercurial, |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
19 SQLite3. On a Unix-based system, Python is probably already |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
20 installed, the rest can be gotten from source or your operating |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
21 system's package manager if it has one. |
| 19 | 22 |
| 23 2) Clone this repository | |
| 24 | |
|
34
22d514498935
Move the configurable parts of settings.py into a conf file
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
33
diff
changeset
|
25 3) In the cloned repository, copy "agora-example.conf" to |
|
22d514498935
Move the configurable parts of settings.py into a conf file
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
33
diff
changeset
|
26 "agora.conf" (advanced users: modify this to suit your needs). |
| 19 | 27 |
| 28 4) Now run | |
| 29 | |
|
28
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
30 $ python manage.py syncdb #Will create an empty database |
| 19 | 31 #(by default: sqlite3) |
| 32 | |
| 33 $ python manage.py runserver #Run a development webserver on port 8000 | |
| 34 | |
| 35 5) Point a browser to http://localhost:8000 | |
| 36 | |
| 37 6) Submit patches. ;-) | |
| 38 | |
| 39 Here's our TODO. At the moment, almost none of this is done. "I" in | |
| 40 the text below indicates "Jordi". | |
| 41 | |
| 42 -- Users can upload bundles of code. | |
| 43 | |
| 44 -- Bundles clearly indicate which free license they are using. I'm | |
| 45 thinking that it's reasonable to restrict allowable licenses to | |
| 46 GPL-compatibility. This is not a stringent requirement, and it | |
| 47 would simplify distribution with Octave. For the moment I'm | |
| 48 considering that this might be relaxed and any license approved | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
49 by the OSI or FSF should be ok. **DONE** The basic framework for |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
50 licenses is in place, but bundles aren't done yet. |
| 19 | 51 |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
52 -- Additionally, there's a place to post quick snippets. They'll be |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
53 under a default free license that the user indicates in their |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
54 preferences. Usually only single bits of code go in there. |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
55 Responding with more snippets will be facilitated. **DONE** |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
56 Except for the license part. I'm changing my mind about this, |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
57 perhaps it's too pedantic to demand clear licenses on code |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
58 snippets. |
| 19 | 59 |
| 60 -- I'm thinking that optionally, I can setup bundles to also | |
| 61 create an hg repo if the uploader requests it, or existing hg | |
| 62 repos can be imported. | |
| 63 | |
| 64 -- When viewing a user's bundle, the bundle as a whole can be | |
| 65 ranked and commented upon by logged in users. The contents of | |
| 66 the bundle can also be browsed from the web without needing to | |
| 67 download the whole bundle. | |
| 68 | |
| 69 -- Logging in is required only to contribute to the site with | |
| 70 code, comments, ranking code. Everything else is public to | |
| 71 anyone. | |
| 72 | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
73 -- Users are encouraged but not required to provide real |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
74 names. **DONE** registration and profiles now do this. |
| 19 | 75 |
| 76 -- Bundles that are somehow deemed to be of high quality can | |
| 77 easily be pushed to Octave-forge (i.e. they've been "forged", | |
| 78 tempered, tested and tried). | |
| 79 | |
| 80 -- A user's landing page will indicate which bundles and snippets | |
| 81 this user has uploaded as well as whatever personal information | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
82 the user would like to provide. **DONE** Except that bundles |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
83 aren't implemented yet. |
| 19 | 84 |
| 85 This README itself also admits patches. |