aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUltrabug <ultrabug@ultrabug.net>2014-12-25 20:16:34 +0100
committerUltrabug <ultrabug@ultrabug.net>2014-12-25 20:16:34 +0100
commit712d737711e1efde5551d349a6a3e4427f4c2274 (patch)
tree4dac746dc88f78e83b306d2367ec68b3316ff176
parentMerge pull request #7 from gentoo/hardened_g (diff)
parentmove CONTRIBUTE into README (diff)
downloaddocker-images-712d737711e1efde5551d349a6a3e4427f4c2274.tar.gz
docker-images-712d737711e1efde5551d349a6a3e4427f4c2274.tar.bz2
docker-images-712d737711e1efde5551d349a6a3e4427f4c2274.zip
Merge pull request #8 from alunduil/update-readme
Update readme
-rw-r--r--CONTRIBUTE.md12
-rw-r--r--README.md27
2 files changed, 21 insertions, 18 deletions
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
deleted file mode 100644
index 5a8c413..0000000
--- a/CONTRIBUTE.md
+++ /dev/null
@@ -1,12 +0,0 @@
-Policy
-======
-
-* Use topic branches (foo) and fix branches (fix/foo) when sending pull requests.
-
-* Try to make meaningful commits with descriptive commit messages. Ideally, there should be a subject line, an empty line, followed by a body.
-
-* Check for unnecessary whitespace with `git diff --check` before committing.
-
-* Your commit history should be clean when sending a pull request. There should be no merge commits on a pull.
-
-* After a code review, it is preferred you use amend/rebase to fix your commits, rather than make a new commit.
diff --git a/README.md b/README.md
index c92375b..a53c871 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,25 @@
-docker-brew-gentoo
-==================
+# Gentoo Docker Images
-We're working on getting an AMD64 automated build atm, all help welcome!
+A repository of Dockerfiles and utilities for generating Gentoo docker images.
+Currently we are working on adding amd64 images and will expand into other
+arches over time.
-Contribute
-==========
+## Inventory
-Join #gentoo-docker on FreeNode IRC and ping us with your ideas!
+* portage
+
+# Contributing
+
+Join us at irc://freenode.net/#gentoo-containers. We'd love to hear any ideas.
+
+## Policy
+
+* use topic branches (i.e. foo) and fix branches (i.e. fix/foo) when submitting
+ pull requests
+* make meaningful commits ideally with the following form:
+ * subject line–what this commit does
+ * blank line
+ * body–why this commit is necessary or desired
+* pull requests should not include merge commits
+* use amend and rebase to fix commits after a pull request has been submitted