README.md in nanoc-3.6.7 vs README.md in nanoc-3.6.8
- old
+ new
@@ -1,129 +1,22 @@
[](https://travis-ci.org/nanoc/nanoc)
-[](https://codeclimate.com/github/nanoc/nanoc)
+[](https://codeclimate.com/github/nanoc/nanoc)
+[](https://coveralls.io/r/nanoc/nanoc)
+[](http://badge.fury.io/rb/nanoc)
-**Please take a moment and [donate](http://pledgie.com/campaigns/9282) to nanoc. A lot of time has gone into developing nanoc, and I would like to keep the current pace. Your support will ensure that nanoc will continue to improve.**
+
-# nanoc 3
+# nanoc
-nanoc is a simple but very flexible static site generator written in Ruby.
-It operates on local files, and therefore does not run on the server. nanoc
-“compiles” the local source files into HTML (usually), by evaluating eRuby,
-Markdown, etc.
+nanoc is a flexible static site generator written in Ruby. See the [nanoc web site](http://nanoc.ws) for more information.
-Note: This documentation looks best with Yardoc, not RDoc.
+**Please take a moment and [donate](http://pledgie.com/campaigns/9282) to nanoc. A lot of time has gone into developing nanoc, and I would like to keep it going. Your support will ensure that nanoc will continue to improve.**
-## Resources
+## Contributing
-The [nanoc web site](http://nanoc.ws) contains a few useful resources to help you get started with nanoc. If you need further assistance, the following places will help you out:
+Contributions are greatly appreciated! Consult the [Development guidelines](http://nanoc.ws/development/) for information on how you can contribute.
-* The [discussion group](http://groups.google.com/group/nanoc)
-* The [IRC channel](irc://chat.freenode.net/#nanoc)
+### Contributors
-## Versioning
+Many thanks to everyone who has contributed to nanoc in one way or another:
-nanoc uses [Semantic Versioning](http://semver.org/).
-
-## Source Code Documentation
-
-The source code is located in `lib/nanoc` and is structured in a few
-directories:
-
-* `base` contains the bare essentials necessary for nanoc to function
- * `source_data` contains raw, uncompiled content that will be compiled
- * `result_data` contains the compiled content
- * `compilation` contains the compilation functionality
-* `cli` contains the commandline interface
-* `data_sources` contains the standard data sources ({Nanoc::DataSource}
- subclasses), such as the filesystem data source
-* `extra` contains stuff that is not needed by nanoc itself, but which may
- be used by helpers, data sources, filters or VCSes.
-* `filters` contains the standard filters ({Nanoc::Filter} subclasses)
- such as ERB, Markdown, Haml, …
-* `helpers` contains helpers, which provide functionality some sites
- may find useful, such as the blogging and tagging helpers
-* `tasks` contains rake tasks that perform a variety of functions such as
- validating HTML and CSS, uploading compiled files, …
-
-The namespaces (modules) are organised like this:
-
-* {Nanoc} is the namespace for everything nanoc-related (obviously). The
- classes in `lib/nanoc/base` are part of this module (not `Nanoc::Base`)
-* {Nanoc::CLI} containing everything related to the commandline tool.
-* {Nanoc::DataSources} contains the data sources
-* {Nanoc::Helpers} contains the helpers
-* {Nanoc::Extra} contains useful stuff not needed by nanoc itself
-* {Nanoc::Filters} contains the (textual) filters
-
-The central class in nanoc is {Nanoc::Site}, so you should start there if
-you want to explore nanoc from a technical perspective.
-
-## Dependencies
-
-nanoc has few dependencies. It is possible to use nanoc programmatically
-without any dependencies at all, but if you want to use nanoc in a proper way,
-you’ll likely need some dependencies:
-
-* The **commandline frontend** depends on `cri`.
-* The **autocompiler** depends on `mime-types` and `rack`.
-* Filters and helpers likely have dependencies on their own too.
-
-If you’re developing for nanoc, such as writing custom filters or helpers, you
-may be interested in the development dependencies:
-
-* For **documentation generation** you’ll need `yard`.
-* For **packaging** you’ll need `rubygems` (1.3 or newer).
-* For **testing** you’ll need `mocha` and `minitest`.
-
-## Contributors
-
-(In alphabetical order)
-
-* Ben Armston
-* Colin Barrett
-* Bil Bas
-* Dmitry Bilunov
-* Fabian Buch
-* Devon Luke Buchanan
-* Stefan Bühler
-* Dan Callahan
-* Brian Candler
-* Jack Chu
-* Michal Cichra
-* Zaiste de Grengolada
-* Vincent Driessen
-* Chris Eppstein
-* Jeff Forcier
-* Riley Goodside
-* Felix Hanley
-* Justin Hileman
-* Starr Horne
-* Daniel Hofstetter
-* Tuomas Kareinen
-* Greg Karékinian
-* Matt Keveney
-* Kevin Lynagh
-* Go Maeda
-* Nikhil Marathe
-* Daniel Mendler
-* Stuart Montgomery
-* Ale Muñoz
-* John Nishinaga
-* Gregory Pakosz
-* Nicky Peeters
-* Christian Plessl
-* Damien Pollet
-* Šime Ramov
-* Xavier Shay
-* Arnau Siches
-* “Soryu”
-* Eric Sunshine
-* Dennis Sutch
-* Takashi Uchibe
-* Matthias Vallentin
-* Ruben Verborgh
-* Scott Vokes
-* Toon Willems
-
-## Contact
-
-You can reach me at <denis.defreyne@stoneship.org>.
+Ale Muñoz, Alexander Mankuta, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Chris Eppstein, Christian Plessl, Colin Barrett, Damien Pollet, Dan Callahan, Daniel Hofstetter, Daniel Mendler, Daniel Wollschlaeger, David Everitt, Dennis Sutch, Devon Luke Buchanan, Dmitry Bilunov, Eric Sunshine, Erik Hollensbe, Fabian Buch, Felix Hanley, Go Maeda, Gregory Pakosz, Grégory Karékinian, Guilherme Garnier, Jack Chu, Jake Benilov, Jasper Van der Jeugt, Jeff Forcier, John Nishinaga, Justin Clift, Justin Hileman, Kevin Lynagh, Louis T., Mathias Bynens, Matt Keveney, Matthew Frazier, Matthias Beyer, Matthias Reitinger, Matthias Vallentin, Michal Cichra, Nelson Chen, Nicky Peeters, Nikhil Marathe, Oliver Byford, Peter Aronoff, Raphael von der Grün, Remko Tronçon, Riley Goodside, Ruben Verborgh, Scott Vokes, Simon South, Spencer Whitt, Stanley Rost, Starr Horne, Stefan Bühler, Stuart Montgomery, Takashi Uchibe, Toon Willems, Tuomas Kareinen, Ursula Kallio, Vincent Driessen, Xavier Shay, Zaiste de Grengolada, Šime Ramov