Skip to content

Update README.md with the current state of the project #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Xylon2 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with the current state of the project #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,26 @@ A minor Emacs mode for running
[Clojure test
mode](https://github.com/technomancy/clojure-mode/blob/master/clojure-test-mode.el).

Note that this is designed for classic expectations, and will not work with the
[clojure.test version](https://github.com/clojure-expectations/clojure-test)

## Important

Versions 0.0.2 and lower use swank, version 0.0.3 and greater use
nrepl. Going forward, only nrepl will be supported.
This package has some major breakage due to changes in the cider API and removal of
legacy Emacs functions.

It is probably better to look at CIDER's built-in test features. [CIDER has
several functions to help you run all your
tests](https://docs.cider.mx/cider/testing/running_tests.html).
Copy link
Contributor

@seancorfield seancorfield Mar 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: the reason this mode exists at all is because classic Expectations cannot be run via the normal test running stuff in the Clojure modes and/or CIDER.

If you're using the clojure.test version of Expectations, this mode is completely irrelevant and should not be used.


## Installation

*Please note Expectations v1.3.7 or greater is required to use expectations-mode.*

You can either install the package manually or use the package manager package.el.

To install using the package manager, add the marmalade repo to your package-archives:

```lisp
(require 'package)
(add-to-list 'package-archives
'("marmalade" . "http://marmalade-repo.org/packages/") t)
```

And package-install expectations-mode in the usual way.
expectations-mode is not in MELPA, so you must install the package manually.

To install manually, download expectations-mode.el, put it somewhere on your Emacs load
path, and require it inside of init.el
Download expectations-mode.el, put it somewhere on your Emacs load path, and
require it inside of init.el

```lisp
(require 'expectations-mode)
Expand Down