aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README7
-rw-r--r--README.md22
-rw-r--r--_config.yml2
3 files changed, 23 insertions, 8 deletions
diff --git a/README b/README
deleted file mode 100644
index ac44b66..0000000
--- a/README
+++ /dev/null
@@ -1,7 +0,0 @@
-## Dependencies
-
-`emerge dev-ruby/nokogiri www-apps/jekyll dev-ruby/kramdown`
-
-## Dynamic information
-
-Once the dependencies have been emerged, run `bash ./bin/update.sh` from the base directory to update the site's dynamically generated information. Expect "LDAP user information" to be skipped when on systems that are not connected to Gentoo's LDAP infrastructure.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30fe1b8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## Dependencies
+
+On Gentoo systems using Portage:
+
+`emerge www-apps/jekyll dev-ruby/nokogiri dev-ruby/kramdown dev-ruby/rbst`
+
+* www-apps/jekyll - The static web engine for this site.
+* dev-ruby/nokogiri - A Ruby plugin to add support for parsing HTML/XML documents. Takes action on devaway, mirror informaiton, packages, blogs (planet), and wiki articles.
+* dev-ruby/kramdown - A Ruby plugin to add support for kramdown, a superset of the Markdown markup language. kramdown is used throughout this site.
+* dev-ruby/rbst - A Ruby wrapper for processing reStructuredText via Python's Docutils. Required for GLEP generation.
+
+### Optional
+
+* net-misc/wget - Downloads files containing dynamic data (see below).
+
+## Dynamic data
+
+Once the dependencies have been emerged, run `bash ./bin/update.sh` from the base directory to update the site's data that is dynamically generated. Expect "LDAP user information" to be skipped on systems that are not directly connected to Gentoo's LDAP infrastructure.
+
+## Generation
+
+Issue a `jekyll serve` to build the site.
diff --git a/_config.yml b/_config.yml
index 1ede2b3..ff94c94 100644
--- a/_config.yml
+++ b/_config.yml
@@ -41,5 +41,5 @@ defaults:
values:
layout: passthrough
-exclude: ['bin', 'README', 'TODO']
+exclude: ['bin', 'README.md', 'TODO']
plugins: ['nokogiri']