Skip to content

Commit

Permalink
docs(README.md): Update/Fix README.md
Browse files Browse the repository at this point in the history
* Add missing links in "Howtos" from docs/index.md

* Fix URLs format in "License and copyright"

* Remove unnecessary spaces before bullet list elements
  • Loading branch information
cesclass committed Jun 30, 2022
1 parent c538200 commit 7174547
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Howtos
* [How to deploy an instance of Learn OCaml?](https://github.com/ocaml-sf/learn-ocaml/blob/master/docs/howto-deploy-a-learn-ocaml-instance.md)
* [How to deploy Learn-OCaml statically?](https://github.com/ocaml-sf/learn-ocaml/blob/master/docs/howto-deploy-learn-ocaml-statically.md)
* [How to practice OCaml with Learn-OCaml?](https://github.com/ocaml-sf/learn-ocaml/blob/master/docs/howto-practice-ocaml.md)
* [How to classify students answers?](https://github.com/ocaml-sf/learn-ocaml/blob/master/docs/howto-classify-students-answers.md)

Contacts
--------
Expand All @@ -46,39 +47,39 @@ permitted, alteration requires prior written authorization by
OCamlPro.

The OCaml / ocaml.org logo is released under the very liberal UNLICENSE.
See (https://github.com/ocaml/ocaml.org/blob/master/LICENSE.md).
See [https://github.com/ocaml/ocaml.org/blob/master/LICENSE.md](https://github.com/ocaml/ocaml.org/blob/master/LICENSE.md).

The Inconsolata font is released under the Open Font License.
See (http://www.levien.com/type/myfonts/inconsolata.html).
See [http://www.levien.com/type/myfonts/inconsolata.html](http://www.levien.com/type/myfonts/inconsolata.html).

The Biolinum font is licensed under the GNU General Public License with
a the 'Font-Exception'.
See (http://www.linuxlibertine.org).
See [http://www.linuxlibertine.org](http://www.linuxlibertine.org).

The public instance of Learn OCaml uses the Fontin font instead of
Biolinum. This font is licensed under the exljbris Font Foundry Free
Font License Agreement, which, to our understanding, does not allow us
to redistribute it. See (http://www.exljbris.com/eula.html). You will
to redistribute it. See [http://www.exljbris.com/eula.html](http://www.exljbris.com/eula.html). You will
optionally have to procure the files by yourself while building the
app. If not, the CSS provides a reasonable fallback font.

Contributions to this repository are placed under the MIT
license. This means that we can merge them with the same license as
the rest of the codebase, while you keep all the rights on your code.
And we will not have to bother you with any future license update.
See (https://opensource.org/licenses/MIT).
See [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT).

Authors and Acknowledgements
----------------------------

Learn-OCaml is a free software by the [OCaml Software Foundation](https://ocaml-sf.org).

* The main authors are Benjamin Canou, Çağdaş Bozman and Grégoire Henry.
* The main authors are Benjamin Canou, Çağdaş Bozman and Grégoire Henry.

* It builds on the previous experience of Try OCaml by Çağdaş Bozman.
* It builds on the previous experience of Try OCaml by Çağdaş Bozman.

* We heavily use js_of_ocaml, so thanks to the Ocsigen team.
* We heavily use js_of_ocaml, so thanks to the Ocsigen team.

* The text editing component is a customized version of ACE.
* The text editing component is a customized version of ACE.

* We also include a derivative of ppx_metaquot by Alain Frisch.
* We also include a derivative of ppx_metaquot by Alain Frisch.

0 comments on commit 7174547

Please sign in to comment.