From: Ed Kellett <redacted>
Date: Sun, 28 Feb 2016 03:55:14 +0000 (+0000)
Subject: move contributing information around
X-Git-Url: https://jfr.im/git/irc/freenode/web-7.0.git/commitdiff_plain/d0bfb1936c594166a90ca793cd8d224417325658?ds=sidebyside

move contributing information around
---

diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
deleted file mode 100644
index 28d100a79..000000000
--- a/CONTRIBUTE.md
+++ /dev/null
@@ -1,26 +0,0 @@
-## Dev Requirements:
-
-* [Myth](http://www.myth.io/)
-* [svgo](https://github.com/svg/svgo)
-* [cms7](https://github.com/edk0/cms7)
-
-## Building
-
-Install `myth` and `svgo` globally by running `npm install -g myth svgo`.
-
-Python 3 is needed for `cms7` to work. Make a virtualenv with `pyvenv env`,
-then run `pip install -r requirements.txt` to install `cms7`.
-
-With dependencies installed, just run `cms7` to build. The output files are in
-the `out/` folder. You can run `python -m http.server` in the `out/` folder to
-serve the compiled files, and go to `http://localhost:8000` to see the files.
-
-## Git
-
-`master` is automatically deployed to https://freenode.github.io/web-7.0/. It
-is also configured to reject commits that haven't had a build succeed in a
-branch or pull request; make one and ideally get someone else to confirm.
-
-Branches are cheap; use one per feature.
-
-Changes should be tested on both big and small screens.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..528d23f9d
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+## Contributing
+
+- Whenever possible, one commit per feature.
+- If feature/pull-request branches have only one developer, please regularly
+  rebase them onto master until they are merged in.
+- Don't merge branches with meaningless commit messages; always squash them
+  instead.
+- Wait for discussion of big changes. Your branches will still be here
+  tomorrow.
diff --git a/README.md b/README.md
index 584347157..583c34ea7 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,45 @@
 A shiny replacement for http://freenode.net.
 
 
+## Building
+
+You'll need our node.js dependencies:
+
+```console
+$ npm install -g myth svgo
+```
+
+Then, assuming a Python 3.4 (or later) installation:
+
+```console
+$ python3 -m venv env
+$ . env/bin/activate
+$ pip install -r requirements.txt
+$ cms7
+```
+
+If everything went well, you should see a lot of log output, and `out/` will
+have the website in it.
+
+Because we generate the site statically, you'll need to re-run `cms7` each
+time you change something. If your editor likes compile commands that can run
+from any directory, you can also use `cms7 -c /path/to/config.yml`.
+
+
+## Contributing
+
+- Whenever possible, one commit per feature.
+- If feature/pull-request branches have only one developer, please regularly
+  rebase them onto master until they are merged in.
+- Don't merge branches with meaningless commit messages; always squash them
+  instead.
+- Wait for discussion of big changes. Your branches will still be here
+  tomorrow.
+
+
 ## Architecture / Orientation
 
-The site is statically generated from
+The site is generated from
 [Markdown](https://daringfireball.net/projects/markdown/) sources and
 [Jinja2](http://jinja.pocoo.org/) templates, found in `content/` and
 `templates/` respectively. The Travis build deploys to GitHub Pages