branch: elpa/buttercup
commit 25cb3500c45cbc898952c961883da7f1ba01c85d
Author: Jorgen Schaefer <cont...@jorgenschaefer.de>
Commit: Jorgen Schaefer <cont...@jorgenschaefer.de>
Rename docs to be more easily understandable
See comments on #40
---
README.md | 4 ++--
docs/{usage.md => running-tests.md} | 4 ++--
docs/testrunners.md | 15 ---------------
docs/{introduction.md => writing-tests.md} | 0
4 files changed, 4 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 7c5a662..36b7b53 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ The framework is heavily inspired by
## Example
-*Full article: [Introduction](docs/introduction.md)*
+*Full article: [Writing Tests](docs/writing-tests.md)*
A simple test looks like this.
@@ -28,7 +28,7 @@ A simple test looks like this.
## Installation and Usage
-*Full article: [Usage](docs/usage.md)*
+*Full article: [Running Tests](docs/running-tests.md)*
You can install buttercup from
[MELPA Stable](http://stable.melpa.org/). Add the following to your
diff --git a/docs/usage.md b/docs/running-tests.md
similarity index 96%
rename from docs/usage.md
rename to docs/running-tests.md
index e6be162..2cbc2e3 100644
--- a/docs/usage.md
+++ b/docs/running-tests.md
@@ -3,8 +3,8 @@
Buttercup is primarily meant to be used non-interactively, to
automatically test a project independent of a user’s setup, before a
commit and on a continuous integration platform. Because of this, the
-workflow for buttercup does not use interactive commands but instead
-the command line.
+recommended workflow for buttercup does not use interactive commands
+but instead the command line.
## Cask
diff --git a/docs/testrunners.md b/docs/testrunners.md
deleted file mode 100644
index 34aae59..0000000
--- a/docs/testrunners.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Test Runners
-
-Evaluating `describe` forms just stores the suites. You need to use a
-test runner to actually evaluate them. Buttercup comes with three test
-runners by default:
-
-- `buttercup-run-at-point` — Evaluate the topmost `describe` form at
- point and run the suite it creates directly. Useful for interactive
- development. But be careful, this uses your current environment,
- which might not be clean (due to said interactive development).
-- `buttercup-run-discover` — Find files in directories specified on
- the command line, load them, and then run all suites defined
- therein. Useful for being run in batch mode.
-- `buttercup-run-markdown` — Run code in markdown files. Used to
- run this file’s code.
diff --git a/docs/introduction.md b/docs/writing-tests.md
similarity index 100%
rename from docs/introduction.md
rename to docs/writing-tests.md
