diff --git a/README.md b/README.md index c88f47e..77ab4b0 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,21 @@ Please note that `dune install` installs the file under the same local directory This option is meant to be used when packaging the library for distributions using binary packages such as debian or ubuntu packages, RPM package etc. +## Migration form 1.x.x + +The library's API was update and cleaned up in its version `2.0.0` as part of the migration to support OCaml `5.0.0`. As a +consequence, modules depending on the old library are now incompatible with the new library. + +If you were previously using the `CamomileLibraryDefault` module, all you should have to do it +used the new top-level `Camomile` module. + +If you were previously using the configuration functor to define your own library, you should be able to +use the new `Camomile.Make` functor available at top-level as well. + +Otherwise, you can check the `compat/` directory of this repository. It contains a simple compatibility +library that you should be able to re-use in your code. We do, however, recommend simply updating your +code to the new API. It really shouldn't be too hard! + ## Using libraries ### Configuration diff --git a/camomile-compat.opam b/camomile-compat.opam deleted file mode 100644 index 779229d..0000000 --- a/camomile-compat.opam +++ /dev/null @@ -1,34 +0,0 @@ -# This file is generated by dune, edit dune-project instead -opam-version: "2.0" -version: "2.0.1" -synopsis: "Compatibility Camomile module" -description: - "This module provides a backward-compatible API for projects depending on pre 2.0.0 Camomile API." -maintainer: ["romain.beauxis@gmail.com"] -authors: ["Yoriyuki Yamagata"] -license: "LGPL-2.0-or-later WITH OCaml-LGPL-linking-exception" -homepage: "https://github.com/savonet/Camomile" -doc: "https://savonet.github.io/Camomile/" -bug-reports: "https://github.com/savonet/Camomile/issues" -depends: [ - "dune" {>= "3.4"} - "camomile" - "odoc" {with-doc} -] -build: [ - ["dune" "subst"] {dev} - [ - "dune" - "build" - "-p" - name - "-j" - jobs - "--promote-install-files=false" - "@install" - "@runtest" {with-test} - "@doc" {with-doc} - ] - ["dune" "install" "-p" name "--create-install-files" name] -] -dev-repo: "git+https://github.com/savonet/Camomile.git" diff --git a/compat/dune b/compat/dune index 98e72b3..f58d648 100644 --- a/compat/dune +++ b/compat/dune @@ -5,6 +5,5 @@ (library (name camomileCompat) - (public_name camomile-compat) (libraries camomile camomile.lib) (wrapped false)) diff --git a/dune-project b/dune-project index cba03aa..02e8200 100644 --- a/dune-project +++ b/dune-project @@ -26,9 +26,3 @@ designed for Unicode Standard 3.2.") (stdlib-random :with-test) (ocaml (>= 4.13))) (sites (share database) (share mappings) (share charmaps) (share locales))) - -(package - (name camomile-compat) - (synopsis "Compatibility Camomile module") - (description "This module provides a backward-compatible API for projects depending on pre 2.0.0 Camomile API.") - (depends camomile))