README.md in nanoc3-3.2.0a1 vs README.md in nanoc3-3.2.0a2
- old
+ new
@@ -8,27 +8,25 @@
Note: This documentation looks best with Yardoc, not RDoc.
## Resources
The [nanoc web site](http://nanoc.stoneship.org) contains a few useful
-resources to help you get started with nanoc:
+resources to help you get started with nanoc. If you need further assistance,
+the following places will help you out:
-* The [tutorial](http://nanoc.stoneship.org/tutorial)
-* The [manual](http://nanoc.stoneship.org/manual)
-* The [migration guide](http://nanoc.stoneship.org/migrating)
-
-If you need assistance, the following places will help you out:
-
* The [discussion group](http://groups.google.com/group/nanoc)
* The [IRC channel](irc://chat.freenode.net/#nanoc)
## Source Code Documentation
The source code is located in `lib/nanoc3` 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 ({Nanoc3::DataSource}
subclasses), such as the filesystem data source
* `helpers` contains helpers, which provide functionality some sites
may find useful, such as the blogging and tagging helpers
@@ -50,34 +48,44 @@
The central class in nanoc is {Nanoc3::Site}, so you should start there if
you want to explore nanoc from a technical perspective.
## Dependencies
-nanoc itself can be used without installing any dependencies. Some
-components, however, do have 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 `cli`.
* 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`.
+* For **testing** you’ll need `mocha` and `minitest`.
## Contributors
(In alphabetical order)
+* Ben Armston
* Colin Barrett
* Dmitry Bilunov
+* Devon Luke Buchanan
* Brian Candler
* Chris Eppstein
+* Felix Hanley
* Starr Horne
+* Ale Muñoz
* Nicky Peeters
* Christian Plessl
* Šime Ramov
+* Xavier Shay
* “Soryu”
* Eric Sunshine
* Dennis Sutch
-
-Special thanks to Ale Muñoz.
## Contact
You can reach me at <denis.defreyne@stoneship.org>.