From 6ac511c87bc3988dff6bc608125f2c10e8d609dd Mon Sep 17 00:00:00 2001 From: Sylvain Le Gall Date: Wed, 16 Oct 2019 09:50:44 +0200 Subject: [PATCH] Make the README more GitHub friendly. --- README.md | 28 ++++++++++++++++++++++++++++ README.txt | 25 ------------------------- 2 files changed, 28 insertions(+), 25 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..242f61a --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +ocaml-debian-formats - Parse debian files +========================================= + +[![Travis status][travis-img]][travis] + +This library allows to parse various files used in Debian packaging: +* changelog files +* source and binary control files +* watch files + +[travis]: https://travis-ci.org/gildor478/ocaml-debian-formats +[travis-img]: https://travis-ci.org/gildor478/ocaml-debian-formats.svg?branch=master +[opam]: https://opam.ocaml.org + +Installation +------------ + +The recommended way to install ocaml-debian-formats is via the [opam package manager][opam]: + +```sh +$ opam install debian-formats +``` + +Documentation +------------- + +* API documentation is + [available online](https://gildor478.github.io/ocaml-debian-formats). diff --git a/README.txt b/README.txt deleted file mode 100644 index 2b5ab8f..0000000 --- a/README.txt +++ /dev/null @@ -1,25 +0,0 @@ -(* OASIS_START *) -(* DO NOT EDIT (digest: 5ce0c175e896576b4ee03fad841f5fe2) *) - -ocaml-debian-formats - Parse debian files -========================================= - -See the file [INSTALL.txt](INSTALL.txt) for building and installation -instructions. - -Copyright and license ---------------------- - -ocaml-debian-formats is distributed under the terms of the GNU Lesser General -Public License version 2.1 with OCaml linking exception. - -(* OASIS_STOP *) - - -The main repository for developping this library can be found on -[github](https://github.com/gildor478/ocaml-debian-formats). - -Releases are available on the -[forge site](https://forge.ocamlcore.org/projects/debian-formats/) -in the [files section](https://forge.ocamlcore.org/frs/?group_id=358). -