Permalink
Browse files

Adding cname and README

  • Loading branch information...
1 parent 4879581 commit 664ca9c5846f5764eadf003fcc055576c77affcb @renoirb committed Aug 30, 2012
Showing with 78 additions and 0 deletions.
  1. +1 −0 CNAME
  2. +77 −0 README.md
View
1 CNAME
@@ -0,0 +1 @@
+htmlcsstherightway.org
View
@@ -0,0 +1,77 @@
+# Learn HTML and CSS the Right way
+
+## Overview
+
+This is the GitHub Pages repository for the _HTML CSS: The Right Way_ project.
+
+* This website is a Jekyll project.
+* Each section and sub-section are a Markdown file in `_posts/`.
+* Sub-sections have `isChild: true` in their front matter.
+* The navigation and page structure are automatically generated.
+
+## Spread the Word!
+
+This is a collection of everything a frontend developer should know regarding best practices and guidelines. It is meant for complete newbie to learn what is the result of other's experience and learn "the right way". Because the web changed so much, we should not do the same past mistakes again.
+
+## How to Contribute
+
+### Ask how to do something
+1. Go to the [issue tracker, suggest in "How do I..." milestone](https://github.com/renoirb/htmlcsstherightway/issues?milestone=1)
+2. Thank you!
+
+### Add to content
+1. Fork and edit
+2. Optionally install [Ruby](https://rvm.io/rvm/install/) with [Jekyll](https://github.com/mojombo/jekyll/) gem to preview locally
+3. Submit pull request for consideration
+
+### Contributor Style Guide
+
+1. Use American English spelling (*primary English repo only*)
+2. Use four (4) spaces to indent text; do not use tabs.
+3. Wrap all text to 120 characters.
+4. Code samples should adhere to PSR-1 or higher.
+
+## Where
+
+<http://htmlcsstherightway.org>
+
+### Translations
+
+Project is very new. You can fork and start translating.
+
+To avoid fragmentation and reader confusion, please choose one of these options:
+
+1. We link to your GitHub Pages fork with `[username].github.com/htmlcsstherightway`
+2. We link to your GitHub Pages fork with a subdomain (e.g. "fr.htmlcsstherightway.com")
+
+If you use a subdomain, enter the subdomain into the `CNAME` file, and ask us to setup DNS for you. If you do not use a subdomain, remove the `CNAME` file entirely else your fork will not build when pushed.
+
+When your translation is ready, open an issue on the Issue Tracker to let us know.
+
+## Why
+
+There is a lot of community efforts regarding open-sourcing best practices and how to do "the right way".
+
+This repository aims to solve this problem regarding Frontend, HTML and CSS development.
+
+Most interrestingly, most of them are on a "fork", "pull request" community effort and follows the line of other great initiatives:
+
+* [PHP: The Right Way](http://www.phptherightway.com/)
+* [Survive the Deep End: PHP Security](http://phpsecurity.readthedocs.org/en/latest/index.html)
+* [Learn Python the Hard Way](http://learnpythonthehardway.org/)
+* [Javascript Patterns collection](http://shichuan.github.com/javascript-patterns/)
+
+
+## Who
+
+My name is [Renoir Boulanger](http://twitter.com/renoirb). I am member of French Canadian (Québec) Web Standards community non for profit organization called W3Québec. And I am maintaining the site. I build websites since Netscape Communicator.
+
+
+### Collaborators
+
+Your name here :)
+
+
+## License
+
+[Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/)

0 comments on commit 664ca9c

Please sign in to comment.