README.md - first draft

README.md

@@ -0,0 +1,52 @@
+# WhenWe
+
+Whenwe is dead. Long love Whenwe?
+
+A "when-we" is a nostagic reminisce. This is an archive of when-wes, currently.
+
+However, it may grow into a database of mini-biographies. Time will tell...
+
+## Structure
+
+- `src/` - the website content and templates
+- `bin/` - helper scripts
+
+Everything in the top directory are configs and documentation, like this.
+
+## Requirements
+
+The site is built using Eleventy. We assume you have Git, NodeJS and NPM installed.
+
+## Installation for development or deployment
+
+    git clone $whenwe_repo_url
+	cd whenwe
+	npm install
+	
+## Development
+
+    npm run server
+
+Now you should be able to visit the development site in your browser at http://localhost:8080
+
+If you edit the content in src/ - it should rebuild the site. Your browser should refresh automatically, but if not, refresh it manually.
+
+See [./src/README.md](./src/README.md) for more information.
+
+## Deployment
+
+Currently the destination is configured in package.json, as part of the definition of the `deploy` run-script.  To change the destination, change that.
+
+`rsync` is used for deploying the site. Therefore you need to have that installed and on the path.
+
+You will need `ssh` access to the destination.  Setting that up is outside the scope of this document, but if you have your own web space, you will probably know about this already, and if not, you will need the assistance of someone who does. For setting up your ssh client, it depends on your OS - there are guides online.
+
+But given that, the deploy process goes like this:
+
+    npm run build
+    npm run deploy
+
+## Issues and questions
+
+These can be submitted via the issue tracker attached to this repository.  You may need to create an account.
+