Commit 8f12abd1 authored by Sean Whitton's avatar Sean Whitton

patch README for Debian

parent e9a0d005
# Buttercup — Behavior-Driven Emacs Lisp Testing # Buttercup — Behavior-Driven Emacs Lisp Testing
[![Build Status](https://api.travis-ci.org/jorgenschaefer/emacs-buttercup.svg?branch=master)](https://travis-ci.org/jorgenschaefer/emacs-buttercup)
[![MELPA Stable](http://stable.melpa.org/packages/buttercup-badge.svg)](http://stable.melpa.org/#/buttercup)
![Ranculus repens, photo by sannse](docs/images/buttercup.jpg)
Buttercup is a behavior-driven development framework for testing Emacs Buttercup is a behavior-driven development framework for testing Emacs
Lisp code. It allows to group related tests so they can share common Lisp code. It allows to group related tests so they can share common
set-up and tear-down code, and allows the programmer to “spy” on set-up and tear-down code, and allows the programmer to “spy” on
...@@ -16,7 +11,7 @@ The framework is heavily inspired by ...@@ -16,7 +11,7 @@ The framework is heavily inspired by
## Example ## Example
*Full article: [Writing Tests](docs/writing-tests.md)* *Full article: [Writing Tests](writing-tests.md)*
A simple test looks like this. A simple test looks like this.
...@@ -26,26 +21,11 @@ A simple test looks like this. ...@@ -26,26 +21,11 @@ A simple test looks like this.
(expect t :to-be t))) (expect t :to-be t)))
``` ```
## Installation and Usage ## Usage
*Full article: [Running Tests](docs/running-tests.md)*
You can install buttercup from
[MELPA Stable](http://stable.melpa.org/). Add the following to your
`init.el` or `.emacs` file:
```
(require 'package)
(add-to-list 'package-archives
'("melpa-stable" . "http://stable.melpa.org/packages/") t)
```
This should allow you to `M-x package-install RET buttercup RET`.
Alternatively, users of Debian 9 or later or Ubuntu 16.10 or later may *Full article: [Running Tests](running-tests.md)*
simply `apt-get install elpa-buttercup`.
Now create a file called `test-feature.el` with these contents: Create a file called `test-feature.el` with these contents:
```Lisp ```Lisp
(describe "A suite" (describe "A suite"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment