Permalink
Browse files

tweaked documentation

  • Loading branch information...
inmarelibero committed Oct 1, 2012
1 parent 622c2c1 commit dfa0d59236ee258653316b64ac35ef5aae778ec9
Showing with 56 additions and 3 deletions.
  1. +56 −3 README.md
View
@@ -1,4 +1,57 @@
-SymfonyBricks
-=============
+# SymfonyBricks
-SymfonyBricks project public repository
+This is the public code repository of the entire website [symfonybricks.com](http://symfonybricks.com) (not yet deployed).
+
+## Objectives
+
+__[symfonybricks.com](http://symfonybricks.com)__ wants to be a website built by the community for the community.
+
+The objective is to create a repository of code snippets and guides related to Symfony that can be submitted by users.
+
+## Philosophy of symfonybricks.com
+
+When a developer (eg: you) has to face a difficult task for him/her, a common behavior should be (before spending *x* hours multiplied by *3*) searching on internet if someone (more or less in order) already resolved that problem, or resolved a similar problem, or wrote something requiring help and someone other helped him.
+
+Many times you found useful information, but it is often fragmentary, put in very different places and not consistent regarding the format. In one word: __not organic__.
+
+
+The philosophy of __[symfonybricks.com](http://symfonybricks.com)__ follows two binaries:
+
+1. provide a repository of publicly shared:
+ - recipes
+ - code snippets
+ - cookbooks
+ - suggestions
+ - help requests
+ - ... (what more?)
+
+2. leave the development of the entire platform to the community
+
+
+__[symfonybricks.com](http://symfonybricks.com)__, as well as contain many cool snippets of great code, wants to be itself an example of Symfony best practices. And more: __the entire platform serves and is created by the community with an open-source philosophy__, the same that distinguishes Symfony. If you are a Symfony lover, you should be definitively interested in symfonybricks.com!
+
+## Technical specifications
+
+Here is a list of tools used to build __[symfonybricks.com](http://symfonybricks.com)__:
+
+Used tools very hardly subjected to discussion:
+
+- [Symfony (v 2.1)](http://www.symfony.com)
+- [Less css](http://lesscss.org/)
+
+Used tools optionally subjected to discussion:
+
+- [Bootstrap](http://twitter.github.com/bootstrap/)
+- [jQuery](http://jquery.com/)
+
+## How you can help
+
+- The very first thing you can do after reading all this document is to comment this issue: [is the purpose of symfonybricks.com clear?](https://github.com/inmarelibero/SymfonyBricks/issues/1)
+- currently this project is not ready to be forked, more documetnation will be available soon
+- you can keep in touch, watch, follow, tweet, retweet and many other beautyful bozzwords!
+
+## Who is behind symfonybricks.com
+
+The repository mantainer is me, [inmarelibero](https://github.com/inmarelibero) \([twitter](https://twitter.com/inmarelibero)\). I'm a Symfony lover and had this idea, simply.
+
+It is also possible that this project is starting for fun, but I think I'm not the only one having fun with sf.

0 comments on commit dfa0d59

Please sign in to comment.