Skip to content
Newer
Older
100644 220 lines (161 sloc) 8.93 KB
be6ecfc @steveklabnik Updating readme [ci skip]
steveklabnik authored Sep 11, 2011
1 <pre>
2 . .
3 .___ ____ _/_ ___ _/_ , . ____
4 / \ ( | / ` | | | (
5 | ' `--. | | | | | | `--.
6 / \___.' \__/ `.__/| \__/ / `._/| \___.'
7
8 </pre>
9
fb03705 @steveklabnik Initial commit, with README driven development.
steveklabnik authored Mar 12, 2011
10 rstat.us is a microblogging site built on top of the [ostatus
11 protocol](http://status.net/wiki/OStatus).
12
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
13 The differences between rstat.us and other microblogging networks are
14 *simplicity* and *openness*.
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 8, 2012
15
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
16 *Simplicity* is a core 'feature' of rstat.us. We pride ourselves on saying
17 'no' to lots of features. Our interface is clean, and easy to understand. We
18 give you just enough features to be interesting, but not enough to be
19 complicated and confusing.
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
20
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
21 *Openness* means the programming code that makes up rstat.us is available for
22 anyone to download, free of charge. Programmers can use that code to run their
23 own websites just like rstat.us, and you can subscribe to your friends on any
24 site that supports the OStatus protocol, like identi.ca. This also means that
25 you can own your data; we'll never stop you from having full access to
26 everything you've put into rstat.us.
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
27
00c31df @carols10cents Limit travis status image to the master branch
carols10cents authored Mar 31, 2012
28 [![Build Status](https://secure.travis-ci.org/hotsh/rstat.us.png?branch=master)](http://travis-ci.org/hotsh/rstat.us)
aa30fcc @steveklabnik Travis: Let's do this.
steveklabnik authored Aug 30, 2011
29
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
30 Quick facts and links
31 ---------------------
1d6404d @steveklabnik updating README with testing/doc fascism
steveklabnik authored Mar 27, 2011
32
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
33 - The stack: ruby/rails 3.2/mongodb
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
34 - [The code][code]
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
35 - [The documentation][docs] (We could use lots of improvement here!)
9414090 @steveklabnik updating readme to point at the new Issues
steveklabnik authored Apr 12, 2011
36 - [The Issues list][issues]
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
37 - Tests are written using [minitest][minitest] and [capybara][capy]
38 - Documentation is generated using [docco][docco] (rocco)
1d6404d @steveklabnik updating README with testing/doc fascism
steveklabnik authored Mar 28, 2011
39
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
40 [code]: http://github.com/hotsh/rstat.us
41 [docs]: http://hotsh.github.com/rstat.us/
9414090 @steveklabnik updating readme to point at the new Issues
steveklabnik authored Apr 12, 2011
42 [issues]: http://github.com/hotsh/rstat.us/issues
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
43 [flow]: http://scottchacon.com/2011/08/31/github-flow.html
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
44 [minitest]: https://github.com/seattlerb/minitest
bc8c4a5 @carols10cents Revert "Defining an author method on feed in an attempt to not get ni…
carols10cents authored Jan 8, 2012
45 [capy]: https://github.com/jnicklas/capybara
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
46 [docco]: https://github.com/jashkenas/docco
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
47
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
48 How to get help
49 ---------------
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
50
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
51 - If you think you've found a bug, please [file a new issue](http://github.com/hotsh/rstat.us/issues) and include:
52 - What happened
53 - What you expected to happen
54 - Steps to reproduce what happened
55 - You can send questions, problems, or suggestions to [the mailing list](http://librelist.com/browser/rstatus/)
56 - Chat with us on IRC in #rstatus on freenode
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
57
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
58 Helping out with rstat.us
bc08179 @steveklabnik First iteration of a 'project page.'
steveklabnik authored Apr 12, 2011
59 -------------------------
60
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
61 If you'd like to contribute, we'd love to have you! Your first order of
62 business is setting up a development environment and making sure all the tests
63 pass on your system. Rstat.us is a Ruby on Rails 3.2 application, so it's
64 assumed you already have [Ruby](http://www.ruby-lang.org/en/downloads) (1.9.2
65 or 1.9.3 preferred, 1.8.7 compatibility is not guaranteed), rubygems (comes
66 with Ruby as of 1.9.2), and [bundler](http://gembundler.com/) on your machine.
67 If not, each of those links has instructions, and we're willing to help via
68 one of the contact methods above if you have issues.
bc08179 @steveklabnik First iteration of a 'project page.'
steveklabnik authored Apr 13, 2011
69
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
70 If you have any problems with the following rstat.us specific steps, _it is a
71 bug_. For example, [this is an issue with running a development environment on
72 windows](https://github.com/hotsh/rstat.us/issues/547) that we need to fix.
73 Please report any issues you have.
fb03705 @steveklabnik Initial commit, with README driven development.
steveklabnik authored Mar 12, 2011
74
9e2cdc3 @jrgifford forgot to add a note on .rvmrc.example to the README
jrgifford authored Sep 13, 2012
75 If you use RVM, you'll want to copy `.rvmrc.example` to `.rvmrc`.
76
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
77 ### Getting a local version running
78
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
79 First off: you will need MongoDB (www.mongodb.org). They have a [quickstart
80 guide][mongo-quickstart] for getting it installed and running.
987c103 added instructions for running locally w/mongo
Kat Hagan authored Mar 24, 2011
81
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
82 Fork the project in github so that you have your own version.
83
b8be55b @codebykat minor fixes and better CoffeeScript instructions
codebykat authored Mar 29, 2011
84 Then do:
987c103 added instructions for running locally w/mongo
Kat Hagan authored Mar 24, 2011
85
1d6404d @steveklabnik updating README with testing/doc fascism
steveklabnik authored Mar 28, 2011
86 $ git clone https://github.com/$MY_GITHUB_USERNAME/rstat.us.git
987c103 added instructions for running locally w/mongo
Kat Hagan authored Mar 24, 2011
87 $ cd rstat.us
88
2504178 added config file sample, updated README with Mongo quickstart instru…
Kat Hagan authored Mar 24, 2011
89 Then update your gemset:
987c103 added instructions for running locally w/mongo
Kat Hagan authored Mar 24, 2011
90
91 $ gem install bundler && bundle install
2c92c82 @tgraham Automating the creation of the SECRET_TOKEN during first dev run and …
tgraham authored Sep 23, 2012
92
93 The config.yml file will be automatically copied/generated for you when you
94 start the server and it does not exist. In dev mode the SECRET_TOKEN will be
95 generated for you and your config.yml file updated. When you run tests a new
96 random SECRET_TOKEN will be generated each time. You can always copy
97 config/config.yml.sample to config/config.yml and edit it on your own beforehand.
98
99 - encoding is UTF-8 by default for ruby 1.9.3
100 - Notes about config settings are in the example file (config/config.yml.example)
95ad926 @carols10cents Remove secret token from repo; use an environment variable instead.
carols10cents authored Sep 3, 2012
101
c37c117 @codebykat list fix and more minor stuff
codebykat authored Mar 29, 2011
102 And start the server:
2504178 added config file sample, updated README with Mongo quickstart instru…
Kat Hagan authored Mar 24, 2011
103
aa27073 @alindeman Documentation updates for Rails 3.1 stack
alindeman authored Sep 5, 2011
104 $ rails server
1d6404d @steveklabnik updating README with testing/doc fascism
steveklabnik authored Mar 28, 2011
105
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
106 Bam! Visit <http://localhost:3000/> in your browser, and you'll be good.
bc8c4a5 @carols10cents Revert "Defining an author method on feed in an attempt to not get ni…
carols10cents authored Jan 8, 2012
107
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
108 ### Local Twitter configuration
109
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 2, 2012
110 Rstat.us allows you to sign in using a Twitter account or link a Twitter
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
111 account to your Rstat.us account. If you'd like to enable that functionality
112 in your dev environment, you'll need to obtain a consumer key and consumer
113 secret from Twitter. Here are the steps to do that:
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 3, 2012
114
115 - Go to https://dev.twitter.com
116 - Sign in using a valid Twitter account
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
117 - Hover over your username in the top right and select "My applications"
118 - Select "Create a new application"
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 3, 2012
119 - Fill in all the required fields (you can use made up information if
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
120 you'd like) and be sure to add a "Callback URL" - e.g. http://rstat.us
121 - Go to the settings tab and select "Read and Write" for the application's
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 3, 2012
122 access type
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
123 - If you haven't already, create a personal `config/config.yml` by copying
124 `config/config.yml.sample`
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 3, 2012
125 - Copy the consumer key and consumer secret (found on the details tab)
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
126 and put them in `config/config.yml` in the development section
24c742f @markzalar adding instructions for making Twitter integration work in dev enviro…
markzalar authored Feb 3, 2012
127 - Restart your rails server
128
de2543b @carols10cents Tweaking the README formatting a bit
carols10cents authored Feb 3, 2012
129 Now you should be able to sign in to your development version with Twitter!
130
131 ### Running the tests
132
bc8c4a5 @carols10cents Revert "Defining an author method on feed in an attempt to not get ni…
carols10cents authored Jan 8, 2012
133 To run the tests you may want to make use of `bundle exec` so you don't get
134 mixed up with different versions of gems that might or might not work with
135 the current rstat.us branch.
b214b4d @burningTyger add bundle exec rake test to README
burningTyger authored Jun 2, 2011
136
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
137 Run all the tests:
138
139 $ bundle exec rake test
140
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
141 You can run convenient subsets of the tests during development; run `bundle
142 exec rake -T` to see all the options. You can also run one test file (for
143 example, `test/models/author_test.rb`) by specifying the filepath in the TEST
144 environment variable:
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
145
146 $ bundle exec rake test TEST=test/models/author_test.rb
b214b4d @burningTyger add bundle exec rake test to README
burningTyger authored Jun 2, 2011
147
ec23fb5 @zzak clean up readme
zzak authored Mar 29, 2011
148 [mongo-quickstart]: http://www.mongodb.org/display/DOCS/Quickstart
149
9f7b5a0 @carols10cents Changing my mind about the level of a header again
carols10cents authored Aug 17, 2012
150 ### Picking something to work on
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
151
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
152 Once you've got a development environment set up with the current tests all
153 passing, you're ready to start working on the code!
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
154
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
155 Please see the [Issues](http://github.com/hotsh/rstat.us/issues); anything
156 without an assignee is up for grabs! Fairly well-defined and small issues are
157 tagged with [Pick
158 me!!!!!!](https://github.com/hotsh/rstat.us/issues?labels=Pick+me!!!!!!&milestone=&page=1&sort=updated&state=open);
159 these would be ideal if you want to help out but aren't sure where to start.
160 Don't hesitate to ask for help or clarification either on an issue itself or
161 through one of the contact methods listed above.
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
162
c968e8c @carols10cents Adjusting some headers in the readme
carols10cents authored Aug 17, 2012
163 ### Development Roadmap
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
164
165 In the second half of 2012, we plan to focus on:
166
167 - [Implementing an API (or two)](https://github.com/hotsh/rstat.us/issues?milestone=8&page=1&sort=updated&state=open)
168
bb9936c @carols10cents Wrapping the README at 80 chars
carols10cents authored Aug 19, 2012
169 We'd love to get rstat.us working with desktop and mobile clients, either
170 through a [twitter-compatible API in a client that allows you to change the
171 endpoint URL](https://github.com/hotsh/rstat.us/issues/562) or working with an
172 app developer to make an rstat.us-specific app. If you work on or would like
173 to work on a client, please let us know! We'd love to get feedback from you.
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
174
85d3ea2 @carols10cents This no longer makes sense to be a 2-levels-deep list
carols10cents authored Aug 17, 2012
175 ### Contribution steps
176
177 We follow [GitHub flow][flow], as a workflow. Basically:
178
179 - Create a feature branch in your fork
180 - Make your change, including tests and documentation as appropriate
181 - Please run all the tests before submitting a pull request!
182 - Submit a pull request from your branch
e5690d2 @carols10cents Documenting our Brand New Commit Bit Policy!
carols10cents authored Aug 19, 2012
183 - Someone with commit access will let you know they are looking at it as soon
184 as they are able. They will review the code and let Travis.ci run the tests
185 before merging. This applies even if you also have commit access.
186
187 ### Becoming a committer
188
189 Following [rubinius'
190 lead](http://www.programblings.com/2008/04/15/rubinius-for-the-layman-part-2-how-rubinius-is-friendly/),
191 once you have one pull request accepted into rstat.us, we will add you to a
192 team that has push+pull access. Basically you will get a big green merge
193 button on other people's pull requests, and you will be able to commit those
194 pull requests to the hotsh/rstat.us master branch.
195
196 This _also_ means that you _could_ push your commits directly to
197 hotsh/rstat.us without going through a pull request. We ask that you not do
198 this, however, so that any code on master has been seen by 2 sets of eyes
161ddc0 @carols10cents Clarifying policy in regards to branches other than master
carols10cents authored Aug 19, 2012
199 (tests don't always catch everything!) This does not apply to branches other
200 than master; if there is long-term collaboration happening, create a feature
201 branch and feel free to push directly to that (but have commits reviewed
202 before merging that branch into master).
203
204 We reserve the right to take away this permission, but in general we trust you
205 to give it to you. :heart: :heart:
b2be1b8 @carols10cents Updating and rearranging the README
carols10cents authored Aug 17, 2012
206
207 Source code documentation
208 -------------------------
209
210 We have documentation that explains our source code using rocco.
211 You can view it [here](http://hotsh.github.com/rstat.us/).
212
213
1d6404d @steveklabnik updating README with testing/doc fascism
steveklabnik authored Mar 28, 2011
214 Running your own node
215 ---------------------
216
7f5ebf0 @carols10cents First draft of readme revisions
carols10cents authored Jan 9, 2012
217 We're working on making this super easy, but right now, we're not quite there.
70b5f69 @steveklabnik Update readme with better warningg.
steveklabnik authored Apr 9, 2011
218
bc8c4a5 @carols10cents Revert "Defining an author method on feed in an attempt to not get ni…
carols10cents authored Jan 8, 2012
219 If you do run your own node, please keep current with upstream.
Something went wrong with that request. Please try again.