File: README.md

package info (click to toggle)
easy-format 1.3.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 200 kB
  • sloc: ml: 1,223; makefile: 15
file content (45 lines) | stat: -rw-r--r-- 1,055 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
**This project is unmaintained. Pull requests won't be reviewed.
  If you would like to contribute, please request a transfer to
  [ocaml-community](https://github.com/ocaml-community/meta).**

Easy-format: indentation made easy
==================================


Documentation
-------------

The documentation is at https://mjambon.github.io/mjambon2016/easy-format.html


Installation
------------

Installation requires dune (formerly known as jbuilder) and ocamlfind.

```
$ make
$ make install
```

Uninstallation
--------------

```
$ make uninstall
```

Examples
--------

Some examples can be run with `make test` before installing.

More examples that require Easy-format to be installed and possibly
dependencies on other packages can be found in the `examples/` subdirectory.

TODO
----

* Port documentation from old website to a better place, possibly https://readthedocs.org/.
* Switch from pure `make` to `jbuilder` for both build/install and development.
* We're looking for an official maintainer for the library and its documentation.