summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2016-02-28 14:57:54 -0500
committerKyle Meyer <kyle@kyleam.com>2016-02-28 15:00:05 -0500
commitf7e2884644591feb3c5c555aa339c4a1aee57b31 (patch)
tree9190ef306de2874b3d60596d0d5ed36b45407818
parentc44f74a155d27cb558e488513dbf21fccce5a6a3 (diff)
downloadsnakemake-mode-f7e2884644591feb3c5c555aa339c4a1aee57b31.tar.gz
Add README
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee87bb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+
+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.
+
+[Snakemake]: https://bitbucket.org/snakemake/snakemake/wiki/Home
+[snakemake-mode.el]: https://github.com/kyleam/snakemake-mode/blob/master/snakemake-mode.el#L24
+[snakemake.el]: https://github.com/kyleam/snakemake-mode/blob/master/snakemake.el#L21