search

jbranchaud / splitting-atoms

:dizzy_face: a community-built, community-driven guide to hacking on the Atom editor
http://jbranchaud.github.io/splitting-atoms/
MIT License
354 stars 29 forks source link

Focus README content on information about the repository #50

Closed jbranchaud closed 10 years ago

jbranchaud commented 10 years ago

Right now the README is a mix of information about this repository (repo description, how to contribute, license information) and Splitting Atoms content (installing packages, etc.). I think the README should focus on the former, repository information. The Splitting Atoms content can be moved to appropriate documents that get built as part of the site.

The README should then also address Jekyll project dependencies, how to get your local environment setup for working with this project, and how to serve the site locally. Anything else?

With respect to serving the site locally, it should be noted that you need to run it with jekyll serve --watch --baseurl=.

ZucchiniZe commented 10 years ago

Nothing that I can think of, have you looked at this?

jbranchaud commented 10 years ago

Fixed in #71.