Skip to content

Commit

Permalink
Created new README.md (about the project), INSTALL.md (how to install…
Browse files Browse the repository at this point in the history
…), CONTRIBUTORS.md (who contributed) and CHANGES.md (what changed). These replace the old 'DevelopmentSoftware' wiki page and README_Calagator*.txt files.t
  • Loading branch information
igal committed Sep 14, 2009
1 parent 9382eec commit 8ac8588
Show file tree
Hide file tree
Showing 6 changed files with 202 additions and 50 deletions.
34 changes: 34 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Changes
=======

Key
---

* [THEME] - Changed theme structure, see `themes/README.txt` for details.
* [SETTING] - Changed setting structure, see `themes/README.txt` for details.
* [MIGRATION] - Change schema, run `rake db:migrate` to apply.
* [DEPENDENCY] - Changed dependencies.

Changes
-------

List of Calagator stable releases and changes, with the latest at the top:

* Next
* [DEPENDENCY] Upgraded to Ruby on Rails 2.3.x and updated many gems.
* [THEME] Upgraded theme_support, which expects layouts to be in `MYTHEME/views/layouts` rather than `MYTHEME/layouts`.
* [SETTING] Added `SECRETS.administrator_email` with email to send errors, extracted it from `config/initalizer/exception_notification_setup.rb`.
* [MIGRATION] Added PaperTrail plugin to provide complete version tracking of all changes, including deletes.
* Added recent changes tracking and rollback using PaperTrail.
* Added new README.md, INSTALL.md, CONTRIBUTORS.md, and CHANGES.md files.
* v0.2009031
* [SETTING] Fixed timezone handling so that the application, added new `timezone` setting.
* [THEME] Fixed layout and added an `ie.6` stylesheet.
* Fixed duplicate checking to eliminate infinite loops and link items to their progenitor.
* Fixed times in Upcoming imports, which violate the iCalendar standard.
* Fixed search sort labels.
* v0.20090503
* Fixed error caused by removal of Time.today from RubyGems 1.3.2 and above.
* Fixed initialization error by delaying loading of tagging extensions till tables are created.
* Added easily customizable `config/database.yml`, see file for usage.
* Added initial MySQL and PostgreSQL ports with many SQL fixes, however, only SQLite3 is currently recommended.
45 changes: 45 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Updated from http://code.google.com/p/calagator/wiki/Contributors on 2009-09-14

Contributors
============

These people have contributed to Calagator's design and implementation:

* Amy Farrell
* Anselm Hook
* Audrey Eschright
* Ben Hengst
* Ben Kerney
* Bill Burcham
* Brian Artiaco
* Brian Felder
* Bryan Stearns
* Chris Faulkner
* Craig Fisk
* Daniel Etra
* Don Park
* Ed Borasky
* Gabrielle Roth
* Igal Koshevoy
* Jeff Schwaber
* Jeremy O'Leary
* Jesse Hallett
* Joe Cohen
* Kevin Scaldaferri
* Lance Albertson
* Leif Warner
* Mark Dilley
* Markus Roberts
* Michael Bunsen
* Paige Saez
* Reid Beels
* Sam Keen
* Sam Livingston-Gray
* Scott Becker
* Selena Deckelman
* Simon Chiang
* Steve Morris
* Ted Kubaska
* Ward Cunningham

Facilities for many code sprints were generously donated by [Cubespace](http://cubespacepdx.com/), "an innovative workspace community in Portland, Oregon. We provide work stations, meeting rooms, and big office amenities to people who would otherwise be working from their homes, coffee shops, or wherever they can set up their laptops or use their cell phones"
67 changes: 67 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Calagator
=========


Setup
-----

To use Calagator, you'll need to:

1. [Install git](http://git-scm.com/) 1.6.x, a distributed version control system. Read the [Github Git Guides](http://github.com/guides/home) to learn how to use *git*.
2. [Install Ruby](http://www.ruby-lang.org/), a programming language. You can use MRI Ruby 1.8.6, MRI Ruby 1.8.7, or [Phusion REE (Ruby Enterprise Edition)](http://rubyenterpriseedition.com/). Your operating system may already have Ruby installed or offer it as a prebuilt package.
3. [Install RubyGems](http://rubyforge.org/projects/rubygems/) 1.3.x, a tool for managing software packages for Ruby. If you already have `rubygems` installed, you may need to update it by running `gem update --system` as root or an administrator.
4. [Install SQLite3](http://www.sqlite.org/), a database engine. Your operating system may already have Ruby installed or offer it as a prebuilt package.
5. [Install Ruby on Rails](http://rubyonrails.org/), a web development framework. You should run `gem install rails -v 2.3.4 --no-ri --no-rdoc` as root or an administrator.
6. [Install Java](http://www.java.com/getjava) 1.6.x, a programming language used to run the Solr search server.

Additional, but out of date, instructions can be found at http://code.google.com/p/calagator/wiki/DevelopmentSoftware


Checkout
--------

To get the Calagator source code:

1. Follow the **Setup** instructions above.
2. Run `git clone git://github.com/calagator/calagator.git` or equivalent, which will create a `calagator` directory with the source code. Go into this directory and run the remaining commands from there.


Configuration
-------------

To configure Calagator:

1. Follow the **Checkout** instructions above.
2. Initialize your database, run `rake db:migrate db:test:prepare`
3. Optionally add a geocoding key so maps will display, follow the instructions in the checkout at `config/geocoder_api_keys.yml.example` and get the key from http://code.google.com/apis/maps/signup.html


Development
-----------

To run Calagator in development mode:

1. Follow the **Configuration** instructions above.
2. Start the *Solr* search server by running `rake solr:start`
3. Start the *Ruby on Rails* web application by running `./script/server` (UNIX) or `ruby script/server` (Windows).
4. Open a web browser to http://localhost:3000/ to use the development server
5. Read the [Rails Guides](http://guides.rubyonrails.org/) to learn how to develop a Ruby on Rails application.
6. When done, stop the *Ruby on Rails* server `script/server` by pressing **CTRL-C** and stop *Solr* by running `rake solr:stop`.


Customization
-------------

If you want to customize your Calagator, do NOT just start modifying files in `app`, `public` and `themes/default`. Please read the instructions in `themes/README.txt` for how to use the theming system.


Security
--------

This application runs with insecure settings by default to make it easy to get started. These default settings include publicly-known cryptography keys that can allow attackers to gain admin privileges to your application. You should create a `config/secrets.yml` file with your secret settings if you intend to run this application on a server that can be accessed by untrusted users, read the [config/secrets.yml.sample](config/secrets.yml.sample) file for details.


Production
----------

Calagator.org runs on [Ubuntu Linux](http://ubuntu.com/), [Phusion REE (Ruby Enterprise Edition)](http://rubyenterpriseedition.com/) and [Phusion Passenger](http://www.modrails.com/).
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Calagator
=========


About
-----

Calagator is an open source community calendaring platform:

* [Calagator.org](http://calagator.org/) is the flagship website running this software.
* [Source code](http://github.com/calagator/calagator/) is available.
* [Mailing list](http://groups.google.com/group/pdx-tech-calendar/) for discussion about the software.
* [Wiki](http://code.google.com/p/calagator/) features many useful articles on using and developing.
* [Issue tracker](http://code.google.com/p/calagator/issues/list) lists outstanding issues and


Why
---

By releasing this code under a liberal MIT open source license, we hope to empower other people so they can better organize and participate in more events that support free sharing of information, open society, and involved citizenry.


Releases
--------

The stable releases this software are tagged with version numbers, such as "v0.20090416", that represent the date they were made. There is also a "stable" branch that points to the current stable release. The [CHANGES.md](http://github.com/calagator/calagator/blob/master/CHANGES.md) file describes significant changes made between stable releases.


Installing
----------

Read the [INSTALL.md](http://github.com/calagator/calagator/blob/master/INSTALL.md) file for details on installing the software.


Contributing
------------

Bug fixes and features are welcomed. Please fork the source code and submit a pull request: <http://github.com/calagator/calagator/tree/master>


Contributors
------------

This free, open source software was made possible by a group of volunteers that put many hours of hard work into it. See the [CONTRIBUTORS.md](http://github.com/calagator/calagator/blob/master/CONTRIBUTORS.md) file for details.


License
-------

This program is provided under an MIT open source license, read the [LICENSE.txt](http://github.com/calagator/calagator/blob/master/LICENSE.txt) file for details.


Copyright
---------

Copyright (c) 2007-2009 Calagator
6 changes: 0 additions & 6 deletions README_Calagator.txt

This file was deleted.

44 changes: 0 additions & 44 deletions README_Calagator_misc.markdown

This file was deleted.

0 comments on commit 8ac8588

Please sign in to comment.