Mercurial > rsstweet

annotate README.rdoc @ 16:fff788625214

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add basic hgignore.
author edogawaconan <me@myconan.net>
date Fri, 05 Sep 2014 20:37:56 +0900
parents a1c9fadc0904
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
1 == README
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
2
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
3 This README would normally document whatever steps are necessary to get the
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
4 application up and running.
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
5
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
6 Things you may want to cover:
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
7
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
8 * Ruby version
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
9
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
10 * System dependencies
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
11
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
12 * Configuration
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
13
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
14 * Database creation
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
15
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
16 * Database initialization
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
17
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
18 * How to run the test suite
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
19
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
20 * Services (job queues, cache servers, search engines, etc.)
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
21
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
22 * Deployment instructions
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
23
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
24 * ...
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
25
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
26
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
27 Please feel free to use a different markup language if you do not plan to run
a1c9fadc0904 Initial.
edogawaconan <me@myconan.net>
parents:
diff changeset
28 <tt>rake doc:app</tt>.