|
Revision 2311, 0.8 kB
(checked in by david, 3 years ago)
|
Added brief README just to get someone started with i2
|
| Line | |
|---|
| 1 |
== i2: Instiki went slim |
|---|
| 2 |
|
|---|
| 3 |
i2 is small, tight rewrite of Instiki as a native Rails application that runs of a database instead of Madeleine. |
|---|
| 4 |
It's better suited for big, public wikis with lots of pages. But it requires more manual work to set up. |
|---|
| 5 |
|
|---|
| 6 |
=== Features |
|---|
| 7 |
|
|---|
| 8 |
* Page caching: Once a page has been viewed, it's cached so only the web server needs to process it |
|---|
| 9 |
|
|---|
| 10 |
* Multiple books: The same installation can host multiple books (separate wikis with their own namespace) |
|---|
| 11 |
|
|---|
| 12 |
|
|---|
| 13 |
=== Dependencies |
|---|
| 14 |
|
|---|
| 15 |
* RedCloth: Use 3.0.3 as 3.0.4 is buggy. |
|---|
| 16 |
|
|---|
| 17 |
|
|---|
| 18 |
=== Getting Started |
|---|
| 19 |
|
|---|
| 20 |
1. Edit database.yml (feel free to use sqlite or pgsql) |
|---|
| 21 |
|
|---|
| 22 |
2. Create the matching database |
|---|
| 23 |
|
|---|
| 24 |
3. Run "rake migrate" (will create all the tables) |
|---|
| 25 |
|
|---|
| 26 |
4. Create your first book through the console: |
|---|
| 27 |
|
|---|
| 28 |
Book.create :name => "My Nice Wiki", :url_name => "wiki" |
|---|
