From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: add README.md especially for github
In-Reply-To: <1414139229-6746-1-git-send-email-david@tethera.net>
References: <1414139229-6746-1-git-send-email-david@tethera.net>
User-Agent: Notmuch/0.18.1+130~ga61922f (http://notmuchmail.org) Emacs/24.3.1
	(x86_64-unknown-linux-gnu)
Date: Fri, 24 Oct 2014 12:16:11 +0300
Message-ID: <m2egtxeskk.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list

On Fri, Oct 24 2014, David Bremner <david@tethera.net> wrote:

> Apparently README.md 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.

LGTM. although I'd prefer README.rst

Tomi

> ---
>  README.md | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>  create mode 100644 README.md
>
> diff --git a/README.md b/README.md
> new file mode 100644
> index 0000000..ce579d8
> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,15 @@
> +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 send to
> +notmuch@notmuchmail.org.
> +
> +For more information about contributing to the project, see
> +
> +
> +  http://notmuchmail.org/contributing/
> -- 
> 2.1.1
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch