Skip to content

Commit d8c29c7

Browse files
chore: update guides with new build system (#472)
1 parent 4745cac commit d8c29c7

File tree

2 files changed

+14
-72
lines changed

2 files changed

+14
-72
lines changed

CONTRIBUTING.md

+13-62
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ In order to be merged into emacs-elixir, contributions must have the following:
4545
* A solid patch that:
4646

4747
* is clear.
48-
* works across all supported versions of Emacs (24+).
48+
* works across all supported versions of Emacs (25+).
4949
* follows the existing style of the code base.
5050
* comments included as needed.
5151

@@ -58,91 +58,42 @@ substantial time for the all-volunteer team to get to.
5858

5959
## How to run tests
6060

61-
There are two tools that helps us to test emacs-elixir:
61+
We use [Eldev](https://github.com/doublep/eldev) as the project management tool and its built-in ERT integration. Our build matrix can be seen in the workflow file in `.github/workflows/ci.yml`. This ensure we run tests in all of our build matrix.
6262

63-
* [Cask](https://github.com/cask/cask) - a project management tool for Emacs that helps automate the package development cycle.
64-
* [Ert-runner](https://github.com/rejeep/ert-runner.el) - a tool for Emacs projects tested using Ert.
65-
66-
### Emacs Version Manager
67-
68-
Emacs has many versions and currently we support from version 24+. If you want to reproduce a bug/issue on a specific version of Emacs, there are some alternatives like EVM. Here is a setup for EVM.
69-
70-
To install [EVM](https://github.com/rejeep/evm), run:
71-
72-
```bash
73-
$ sudo mkdir /usr/local/evm
74-
$ sudo chown $USER: /usr/local/evm
75-
$ curl -fsSkL https://raw.github.com/rejeep/evm/master/go | bash
76-
$ export PATH="~/.evm/bin:$PATH" # Add it to your .bashrc or analogue
77-
```
78-
79-
To list all available Emacs versions you can install, run:
80-
81-
```bash
82-
$ evm list
83-
```
84-
85-
To install a version (for example `emacs-24.3-bin`), run:
86-
87-
```bash
88-
$ evm install emacs-24.3-bin
89-
```
90-
91-
Read more about [EVM](https://github.com/rejeep/evm).
92-
93-
### Cask and ert-runner
94-
95-
To install Cask, run:
96-
97-
```bash
98-
$ curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python
99-
$ export PATH="~/.cask/bin:$PATH" # Add it to your .bashrc or analogue
100-
```
101-
102-
To install [Ert-runner](https://github.com/rejeep/ert-runner.el), run:
103-
104-
```bash
105-
$ cd path/to/emacs-elixir
106-
$ cask install # install ert-runner
107-
$ EMACS=`evm bin emacs-24.3-bin` cask install # install ert-runner for Emacs 24.3
108-
```
63+
Read more about Eldev in its home page.
10964

11065
#### Examples of usage
11166

11267
* Run all tests:
11368

11469
```bash
115-
$ cask exec ert-runner
70+
$ eldev test
11671
```
11772

118-
* Run all tests for Emacs 24.3:
73+
* Check dependencies
11974

12075
```bash
121-
$ EMACS=`evm bin emacs-24.3-bin` cask exec ert-runner
76+
$ eldev deps
12277
```
12378

124-
Run all tests which are tagged `fontification`:
125-
12679
```bash
127-
$ cask exec ert-runner -t fontification
80+
$ eldev deps test
12881
```
12982

130-
Run all tests with `elixir-smie-verbose-p` equal to `t`:
83+
* Run linters
13184

13285
```bash
133-
$ cask exec ert-runner --verbose
86+
$ eldev lint
13487
```
13588

136-
Run all tests interactively:
89+
* Compile project (byte compilation)
13790

13891
```bash
139-
$ cask exec ert-runner --win
92+
$ eldev compile
14093
```
14194

142-
Run all tests which are tagged `fontification` for Emacs 24.3 interactively:
95+
* Clean-up, for example, after compilation
14396

14497
```bash
145-
$ EMACS=`evm bin emacs-24.3-bin` cask exec ert-runner -t fontification --win
98+
$ eldev clean
14699
```
147-
148-
Read more about [Cask](https://github.com/cask/cask) and [Ert-runner](https://github.com/rejeep/ert-runner.el).

README.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
2-
[![Build Status](https://travis-ci.org/elixir-editors/emacs-elixir.svg?branch=master)](https://travis-ci.org/elixir-editors/emacs-elixir)
2+
[![Build Status](https://github.com/elixir-editors/emacs-elixir/actions/workflows/ci.yml/badge.svg)](https://github.com/elixir-editors/emacs-elixir/actions)
33
[![MELPA Stable](http://stable.melpa.org/packages/elixir-mode-badge.svg)](http://stable.melpa.org/#/elixir-mode)
44
[![MELPA](http://melpa.org/packages/elixir-mode-badge.svg)](http://melpa.org/#/elixir-mode)
55

@@ -57,15 +57,6 @@ obtaining `Elixir-Mode`, as the `master` branch is normally quite stable and
5757
With the most recent builds of Emacs, you can pin `Elixir-Mode` to always
5858
use MELPA Stable by adding this to your Emacs initialization:
5959

60-
```el
61-
(add-to-list 'package-pinned-packages '(elixir-mode . "melpa-stable") t)
62-
```
63-
64-
### Via el-get
65-
66-
[el-get](https://github.com/dimitri/el-get) is another popular package manager for Emacs. If you're an el-get
67-
user just do <kbd>M-x el-get-install [RET] elixir-mode [RET]</kbd>.
68-
6960
### Manual
7061

7162
You can install `Elixir-Mode` manually by placing `Elixir-Mode` on your `load-path` and

0 commit comments

Comments
 (0)