Permalink
Browse files

Format README

  • Loading branch information...
1 parent 0a4fbbf commit 847d75ff900f345b4c16d159c8bddf05ef902379 @pietern pietern committed Jun 25, 2012
Showing with 49 additions and 32 deletions.
  1. +49 −32 README.md
View
@@ -6,29 +6,31 @@ All clients are listed in the `clients.json` file.
Each key in the JSON object represents a single client library.
For example:
- "Rediska": {
+```
+"Rediska": {
- # A programming language should be specified.
- "language": "PHP",
+ # A programming language should be specified.
+ "language": "PHP",
- # If the project has a website of its own, put it here.
- # Otherwise, lose the "url" key.
- "url": "http://rediska.geometria-lab.net",
+ # If the project has a website of its own, put it here.
+ # Otherwise, lose the "url" key.
+ "url": "http://rediska.geometria-lab.net",
- # A URL pointing to the repository where users can
- # find the code.
- "repository": "http://github.com/Shumkov/Rediska",
+ # A URL pointing to the repository where users can
+ # find the code.
+ "repository": "http://github.com/Shumkov/Rediska",
- # A short, free-text description of the client.
- # Should be objective. The goal is to help users
- # choose the correct client they need.
- "description": "A PHP client",
+ # A short, free-text description of the client.
+ # Should be objective. The goal is to help users
+ # choose the correct client they need.
+ "description": "A PHP client",
- # An array of Twitter usernames for the authors
- # and maintainers of the library.
- "authors": ["shumkov"]
+ # An array of Twitter usernames for the authors
+ # and maintainers of the library.
+ "authors": ["shumkov"]
- }
+}
+```
## Commands
@@ -39,22 +41,25 @@ description.
We process this Markdown to provide a better experience, so some things to take
into account:
-* Inside text, all commands should be written in all caps, in between backticks.
- For example: ``INCR``.
+* Inside text, all commands should be written in all caps, in between
+ backticks.
+ For example: `INCR`.
-* You can use some magic keywords to name common elements in Redis.
- For example: `@multi-bulk-reply`.
- These keywords will get expanded and auto-linked to relevant parts of the
- documentation.
+* You can use some magic keywords to name common elements in Redis.
+ For example: `@multi-bulk-reply`.
+ These keywords will get expanded and auto-linked to relevant parts of the
+ documentation.
There should be at least two predefined sections: description and return value.
The return value section is marked using the @return keyword:
- Returns all keys matching the given pattern.
+```
+Returns all keys matching the given pattern.
- @return
+@return
- @multi-bulk-reply: all the keys that matched the pattern.
+@multi-bulk-reply: all the keys that matched the pattern.
+```
## Styling guidelines
@@ -68,7 +73,9 @@ To only reformat the files you have modified, first stage them using `git add`
(this makes sure that your changes won't be lost in case of an error), then run
the formatter:
- $ rake format:cached
+```
+$ rake format:cached
+```
The formatter has the following dependencies:
@@ -78,29 +85,39 @@ The formatter has the following dependencies:
Installation of the Ruby gems:
- gem install redcarpet nokogiri
+```
+gem install redcarpet nokogiri
+```
Installation of par (OSX):
- brew install par
+```
+brew install par
+```
Installation of par (Ubuntu):
- sudo apt-get install par
+```
+sudo apt-get install par
+```
## Checking your work
Once you're done, the very least you should do is make sure that all files
compile properly.
You can do this by running Rake inside your working directory.
- $ rake parse
+```
+$ rake parse
+```
Additionally, if you have [Aspell][han] installed, you can spell check the
documentation:
[han]: http://aspell.net/
- $ rake spellcheck
+```
+$ rake spellcheck
+```
Exceptions can be added to `./wordlist`.

0 comments on commit 847d75f

Please sign in to comment.