summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhellekin <hellekin@dyne.org>2016-12-23 00:59:46 +0100
committerhellekin <hellekin@dyne.org>2016-12-23 00:59:46 +0100
commit108dd806561f40fc92b54d7f18675706e8669039 (patch)
treec1ef1fc6325c1a04193fbdf73dd641bb66b1f137 /README.md
parent4543e59a9f0c592af638381c86948b02c9767fbd (diff)
downloadwww-108dd806561f40fc92b54d7f18675706e8669039.tar.gz
www-108dd806561f40fc92b54d7f18675706e8669039.tar.bz2
www-108dd806561f40fc92b54d7f18675706e8669039.zip
Move README to .md
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85de6db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+NEO900.ORG WWW SITE README
+==========================
+
+The Neo900 website is generated by static site generator called Pelican.
+In should be available in most distros as "pelican" or "python-pelican" package.
+
+To launch development server with autorefresh:
+
+ make start
+
+It should now listen to port 8000. Analogically, "make stop" stops the server.
+
+Directory tree:
+
+ /content - news entries
+ /content/pages - pages like "Donate", "Contact us", "Specs" etc.
+ /content/ublog - microblog entries
+ /theme/static - static files copied to output directory with no modifications
+ /theme/templates - main page and templates for pages for stuff like news entries (some are unused)
+
+ /output - the directory where Pelican outputs the page files. Usually shouldn't matter (dev server exposes it via HTTP,
+ and the deploy script launches Pelican by itself), but may be handy when debugging.
+
+For more details on how to write posts with Pelican, refer to http://docs.getpelican.com/en/3.6.0/content.html
+Note that we're using HTML format everywhere, so while reStructuredText and Markdown would work as well, using HTML
+is probably the best for consistency. However, remember that this HTML (especially <meta> tags) as in /content, /content/pages,
+and /content/ublog directories is not the HTML that gets into the browser - <meta> tags will be parsed, and <body> tag wrapped with
+the appropiate template to add stuff like header and footer.
+
+You can make a "one shot" build to /output with:
+
+ make