diff options
authorMatthew Marchese <maffblaster@gentoo.org>2018-01-03 23:27:53 -0800
committerMatthew Marchese <maffblaster@gentoo.org>2018-01-03 23:47:02 -0800
commitacb742953807af515c24c2a6e1bd6735f9446d12 (patch)
tree2f2a1870cc6c8958ad2e288eca736f9763ec1668 /README.md
parentplugins/downloads: support ISO8601 for ISOs & refactor stage parsing. (diff)
Revamp README and add .md extension.
Now includes dependency information for those desiring to build the site. Signed-off-by: Matthew Marchese <maffblaster@gentoo.org>
Diffstat (limited to 'README.md')
1 files changed, 22 insertions, 0 deletions
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.