Add a simple README file
This commit is contained in:
parent
3069a857fb
commit
7cb954d9c7
|
@ -0,0 +1,11 @@
|
|||
Clarion
|
||||
=======
|
||||
|
||||
A CfP automation system for OpenFest.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
1. `git clone https://github.com/ignisf/clarion.git`
|
||||
2. Run `bundle install; bin/rake bootstrap`
|
||||
3. You can now run the rails server with `bin/rails s`
|
28
README.rdoc
28
README.rdoc
|
@ -1,28 +0,0 @@
|
|||
== README
|
||||
|
||||
This README would normally document whatever steps are necessary to get the
|
||||
application up and running.
|
||||
|
||||
Things you may want to cover:
|
||||
|
||||
* Ruby version
|
||||
|
||||
* System dependencies
|
||||
|
||||
* Configuration
|
||||
|
||||
* Database creation
|
||||
|
||||
* Database initialization
|
||||
|
||||
* How to run the test suite
|
||||
|
||||
* Services (job queues, cache servers, search engines, etc.)
|
||||
|
||||
* Deployment instructions
|
||||
|
||||
* ...
|
||||
|
||||
|
||||
Please feel free to use a different markup language if you do not plan to run
|
||||
<tt>rake doc:app</tt>.
|
Loading…
Reference in New Issue