summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2014-10-24 10:25:31 +0200
committerDavid Bremner <david@tethera.net>2014-10-24 11:56:46 +0200
commit8a106ef7284bfbc2335554ff623c17911b6a805c (patch)
tree28946a5faca53710e10f5bf1b6bcad7be5cdfe23 /README.rst
parent4a1ccfedd99de3571d2630dc277ef5b80f9061f7 (diff)
doc: add README.rst especially for github
Apparently README.rst overrides README, so this will show up instead of our generic README on github. If the user is already on github, then clicking a link for more information is not a hardship.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..4009328e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,11 @@
+If you're reading this on github.com, this is a read-only mirror of
+the notmuch project.
+
+For more information about the project, see http://notmuchmail.org.
+
+Please don't send us pull requests on github. If you have a feature
+branch that you want us to look at, use ``git send-email`` to it send
+to notmuch@notmuchmail.org.
+
+For more information about contributing to the project, see
+http://notmuchmail.org/contributing/.