From 84e55fc4e163f5bbd442af2b4f88931fd2818428 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Mon, 13 Apr 2020 21:31:35 -0400 Subject: Rename README --- README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..ec84d70 --- /dev/null +++ b/README @@ -0,0 +1,19 @@ + +[![Build Status](https://travis-ci.org/kyleam/snakemake-mode.svg?branch=master)](https://travis-ci.org/kyleam/snakemake-mode) + +This repo contains two Emacs libraries for [Snakemake]. + +* [snakemake-mode.el] provides a major mode for editing Snakemake + files. + +* [snakemake.el] defines a popup interface for calling Snakemake. + +See the header of each file for more information. + +Both of these are available on MELPA under the +[snakemake-mode package]. + +[Snakemake]: https://snakemake.readthedocs.io/en/stable/ +[snakemake-mode.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake-mode.el#n24 +[snakemake.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake.el#n21 +[snakemake-mode package]: https://melpa.org/#/snakemake-mode -- cgit v1.2.3 From 0dbaba61ac99f372ed430f5d491cf1cfe6a694d8 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Mon, 13 Apr 2020 21:32:47 -0400 Subject: README: Rewrite as a plain text file --- README | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'README') diff --git a/README b/README index ec84d70..9913138 100644 --- a/README +++ b/README @@ -1,19 +1,18 @@ -[![Build Status](https://travis-ci.org/kyleam/snakemake-mode.svg?branch=master)](https://travis-ci.org/kyleam/snakemake-mode) +Emacs support for Snakemake +=========================== -This repo contains two Emacs libraries for [Snakemake]. +This repo contains two Emacs libraries for Snakemake [^1]. -* [snakemake-mode.el] provides a major mode for editing Snakemake - files. + * snakemake-mode.el provides a major mode for editing Snakemake + files. -* [snakemake.el] defines a popup interface for calling Snakemake. + * snakemake.el defines a popup interface for calling Snakemake. See the header of each file for more information. -Both of these are available on MELPA under the -[snakemake-mode package]. +Both of these are available on MELPA under the snakemake-mode package: -[Snakemake]: https://snakemake.readthedocs.io/en/stable/ -[snakemake-mode.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake-mode.el#n24 -[snakemake.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake.el#n21 -[snakemake-mode package]: https://melpa.org/#/snakemake-mode + https://melpa.org/#/snakemake-mode + +[^1]: https://snakemake.readthedocs.io/en/stable/ -- cgit v1.2.3 From 8599b5437416edf5f2ec85652eb671c6e5253fc9 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Mon, 13 Apr 2020 21:32:04 -0400 Subject: README: Add a contributing section --- README | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README') diff --git a/README b/README index 9913138..44260cc 100644 --- a/README +++ b/README @@ -16,3 +16,24 @@ Both of these are available on MELPA under the snakemake-mode package: https://melpa.org/#/snakemake-mode [^1]: https://snakemake.readthedocs.io/en/stable/ + + +Contributing +------------ + +Please send bug reports, feature requests, and other questions to + + snakemake-mode@inbox.kyleam.com + +You can browse previous discussion and development via the +public-inbox [^2] archives at + + https://inbox.kyleam.com/snakemake-mode/ + +If you'd like to contribute a patch, thank you! Please send +it to the same address. + +For more information on sending patches, visit +. + +[^2]: https://public-inbox.org/README -- cgit v1.2.3