Commit 318d6f39 authored by Debian Emacs addons team's avatar Debian Emacs addons team Committed by Sean Whitton

patch-README-for-Debian


Gbp-Pq: Name patch-README-for-Debian.diff
parent 8efadcaf
# Buttercup — Behavior-Driven Emacs Lisp Testing
[![Build Status](https://api.travis-ci.org/jorgenschaefer/emacs-buttercup.png?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
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
......@@ -16,7 +11,7 @@ The framework is heavily inspired by
## Example
*Full article: [Writing Tests](docs/writing-tests.md)*
*Full article: [Writing Tests](writing-tests.md.gz)*
A simple test looks like this.
......@@ -26,26 +21,11 @@ A simple test looks like this.
(expect t :to-be t)))
```
## Installation and 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`.
## Usage
Alternatively, users of Debian 9 or later or Ubuntu 16.10 or later may
simply `apt-get install elpa-buttercup`.
*Full article: [Running Tests](running-tests.md.gz)*
Now create a file called `test-feature.el` with these contents:
Create a file called `test-feature.el` with these contents:
```Lisp
(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