README.md 1.09 KB
Newer Older
zapashcanon's avatar
zapashcanon committed
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
# swhid [![Actions Status](https://github.com/ocamlpro/osh/workflows/build/badge.svg)](https://github.com/ocamlpro/osh/actions) [![coverage percentage](https://raw.githubusercontent.com/ocamlpro/osh/gh-pages/coverage/badge.svg)](https://ocamlpro.github.io/osh/coverage/)

[osh] is an [OCaml] website, providing an API to generate SVG shields.

## Installation

`osh` can be installed with [opam]:

```sh
opam install osh
```

If you don't have `opam`, you can install it following the [how to install opam] guide.

If you can't or don't want to use `opam`, consult the [opam file] for build instructions.

## Quickstart

```ocaml
let () = TODO
```

For more, have a look at the [example] folder, at the [documentation] or at the [test suite].

## About

- [LICENSE]
- [CHANGELOG]

[CHANGELOG]: ./CHANGES.md
[example]: ./example/
[LICENSE]: ./LICENSE.md
[opam file]: ./osh.opam
[test suite]: ./test/

[documentation]: https://ocamlpro.github.io/osh/api/osh/
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
zapashcanon's avatar
typo  
zapashcanon committed
40
[osh]: https://ocamlpro.github.io/osh/