Permalink
Browse files

Added readme with useful information

  • Loading branch information...
1 parent f181563 commit 3a033355b6044356d8d42623b949db8589a8ccec @andreareginato andreareginato committed Oct 2, 2012
Showing with 60 additions and 81 deletions.
  1. +5 −0 CHANGELOG.md
  2. +0 −12 CHANGELOG.rdoc
  3. +1 −0 LICENSE.md
  4. +0 −1 LICENSE.rdoc
  5. +51 −0 README.md
  6. +0 −62 README.rdoc
  7. +1 −1 VERSION
  8. +2 −5 content/index.html
View
@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.1.0 ()
+
+First betterspecs.org version
View
@@ -1,12 +0,0 @@
-= Changelog
-
-
-== Release v0.0.2
-
-* Review Device API content
-* Refactoring animation svg
-
-
-== Release v0.0.1 (2012/02/15)
-
-* First version Lelylan Dev Center
View
@@ -0,0 +1 @@
+Copyright (c) 2012 Andrea Reginato
View
@@ -1 +0,0 @@
-Copyright (c) 2013 Lelylan
View
@@ -0,0 +1,51 @@
+# betterspecs.org
+
+* [Betterspecs website](http://betterspecs.org)
+
+## Requirements
+
+RSpec Best Practices website is tested against MRI 1.9.3.
+
+
+## Installation
+
+ git clone git@github.com:andreareginato/betterspecs.git
+ cd betterspecs
+ bundle install
+ nanoc3 aco
+
+## Resources
+
+* [Betterspecs website](http://betterspecs.org)
+
+## Contributing
+
+Fork the repo on github and send a pull requests with topic branches.
+
+## Feedback
+
+Use the [issue tracker](https://github.com/andreareginato/betterspecs/issues) for bugs.
+[Mail](mailto:andrea.reginato@gmail.com) or [Tweet](http://twitter.com/andreareginato)
+us for any idea that can improve the project.
+
+## Links
+
+* [GIT Repository](https://github.com/andreareginato/betterspecs)
+* [Betterspecs website](http://betterspecs.org)
+
+## Authors
+
+[Andrea Reginato](http://twitter.com/andreareginato)
+
+## Contributors
+
+Special thanks to the following people for submitting patches.
+
+## Changelog
+
+See CHANGELOG
+
+## Copyright
+
+Copyright (c) 2013 [Andrea Reginato](http://lelylan.com).
+See [LICENSE](people/blob/master/LICENSE.md) for details.
View
@@ -1,62 +0,0 @@
-= Introduction
-
-Betterspecs is a collection of best practices on your specs.
-Learn more about at {betterspecs.org}[http://betterspecs.org]
-
-= Requirements
-
-This site is bilt with {nanoc}[http://nanoc.stoneship.org/].
-
-Ruby ~> {1.9.3}[www.ruby-lang.org/en/]
-
-= Installation
-
- bundle install
-
-= Usage
-
-Compile the site locally.
-
- nanoc3 autocompile # start the autocompiler and run the local server
-
-The web site is now visible at localhost:3000. All changes will be
-automatically added.
-
-= Contribute
-
-If you find some errors or you want to improve the documentation fork the repository on github
-and issue a pull request with your changes. No other means of supplying code to the team will
-be accepted.
-
-== Documentation guidelines
-
-* Do not duplicate existing knowledge (read twice what already exists).
-* Add the right information in the right place.
-* Bump to the new version and Update the CHANGELOG.
-
-= Feedback
-
-Use the {issue tracker}[http://github.com/lelylan/developer_site/issues]
-for any but you find or to discuss new best practices. Feedback is always welcome.
-
-= Links
-
-* {GIT Repository}[https://github.com/Lelylan/developer_site]
-* {Lelylan}[http://lelylan.com]
-* {Lelylan | Dev Center}[http://dev.lelylan.com]
-
-= Authors
-
-{Andrea Reginato}[http://lelylan.com]
-
-= Contributors
-
-Special thanks to the following people for submitting patches.
-
-= Changelog
-
-See CHANGELOG
-
-= Copyright
-
-Copyright (c) 2013 {Andrea Regianto}[http://lelylan.com]. See LICENSE for details.
View
@@ -1 +1 @@
-v0.0.1
+v0.1.0
View
@@ -804,11 +804,8 @@
<h1><a name="improve">Improve Better Specs</a></h1>
<p>
-We are seeking for the best guidelines to write "nice to read" specs. Right now a good
-starting point is for sure the
-<a class="see" href="https://github.com/mongoid/mongoid/tree/master/spec/mongoid">Mongoid test suite</a>.
-It uses a clean style and easy to read specs, following most of the best practices
-described here.
+This is an open source project. If you something is missing or incorrect just file an
+issue and start discussing about the topic.
</p>
</article>

0 comments on commit 3a03335

Please sign in to comment.