Skip to content

Commit 4d61a77

Browse files
author
Jean-Baptiste Doderlein
committed
Update README
1 parent 35c704e commit 4d61a77

2 files changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
# BetterOCaml
2-
[![Website betterocaml.ml](https://img.shields.io/website-up-down-green-red/https/betterocaml.ml.svg?style=flat-square)]([https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0))
2+
[![Website betterocaml.ml](https://img.shields.io/website-up-down-green-red/https/perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml.svg?style=flat-square)]([https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml))
33
[![GitHub license](https://img.shields.io/github/license/jbdoderlein/betterocaml?style=flat-square)](https://github.com/jbdoderlein/betterocaml/blob/master/LICENSE)
44
![GitHub repo size](https://img.shields.io/github/repo-size/jbdoderlein/BetterOCaml?style=flat-square)
55
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=flat-square)](https://GitHub.com/jbdoderlein/BetterOCaml/graphs/commit-activity)
66
[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/)
7-
[![CI](https://github.com/jbdoderlein/BetterOCaml/actions/workflows/toplevel_ci_push.yml/badge.svg)](https://github.com/jbdoderlein/BetterOCaml/actions/workflows/toplevel_ci_push.yml)
8-
[<img alt="Deployed with FTP Deploy Action" src="https://img.shields.io/badge/Deployed With-FTP DEPLOY ACTION-%3CCOLOR%3E?style=for-the-badge&color=0077b6">](https://github.com/SamKirkland/FTP-Deploy-Action)
97
[![Awesome Badges](https://img.shields.io/badge/badges-awesome-green.svg?style=flat-square)](https://github.com/Naereen/badges)
108
<p style="font-style: italic"> Language :
119
<span>English</span> |
1210
<a href="https://github.com/jbdoderlein/BetterOCaml/tree/master/lang/french#betterocaml">Français</a>
1311
</p>
1412

15-
An efficient, intuitive and cross-platform web IDE for the [OCaml](https://www.ocaml.org/) language (recent: v4.14.0), with your code interpreted and running in your browser! (no server is needed!)
13+
An efficient, intuitive and cross-platform web IDE for the [OCaml](https://www.ocaml.org/) language (recent: v5.1.0), with your code interpreted and running in your browser! (no server is needed!)
1614

1715
## Installation / Usage
1816

19-
The IDE is hosted [here](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0), <https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0>, but you can host your own version by simply copying the files from the `src/` directory on your host (on a folder of your laptop, or a folder of your web-server, see <http://ocaml.besson.link/> for an example).
17+
The IDE is hosted [here](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml), <https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml>, but you can host your own version by simply copying the files from the `src/` directory on your host (on a folder of your laptop, or a folder of your web-server, see <http://ocaml.besson.link/> for an example).
2018

2119
It is a *purely static website*: once your browser downloads the files from the server (about 7 MB), it will run the OCaml code in its javascript engine, without sending anything to a distant server!
2220
Your data is secure, and this website does not use any third party service cookie :no_good_man: :cookie:.
2321

24-
Without installing any software on your laptop or smartphone, use [this web-based editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0) to access to a complete OCaml REPL and text editor, with syntax highlighting, autocompletion, a full support of recent OCaml syntax and [the entire standard library](https://caml.inria.fr/pub/docs/manual-ocaml/libref/) (except for `Graphics`, `Unix` modules and `Sys.command` function), and multiple-files that you can save to or load from your computer.
22+
Without installing any software on your laptop or smartphone, use [this web-based editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml) to access to a complete OCaml REPL and text editor, with syntax highlighting, autocompletion, a full support of recent OCaml syntax and [the entire standard library](https://caml.inria.fr/pub/docs/manual-ocaml/libref/) (except for `Graphics`, `Unix` modules and `Sys.command` function), and multiple-files that you can save to or load from your computer.
2523

2624
## How to use ?
2725

@@ -41,12 +39,12 @@ If you have any suggestion for a new theme, [open an issue](https://github.com/j
4139

4240
## :sparkles: Use offline?
4341
### :computer: On a laptop or desktop
44-
- If you visit [the editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0) webpage using your favorite browser, and if it works fine, you can add the link to your :star: "favorites", and then later on, if you open the direct link, it should work and load back BetterOCaml... even if your browser is offline!
42+
- If you visit [the editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml) webpage using your favorite browser, and if it works fine, you can add the link to your :star: "favorites", and then later on, if you open the direct link, it should work and load back BetterOCaml... even if your browser is offline!
4543
- This can only work if you don't clean-up or delete the cache of your browser, but it should work even if you turn-off and turn-on again your laptop!
4644

4745
- We [recently](https://github.com/jbdoderlein/BetterOCaml/issues/12) [added](https://github.com/jbdoderlein/BetterOCaml/issues/13) support for an [app manifest](https://github.com/jbdoderlein/BetterOCaml/blob/master/src/manifest.json) and [service workers](https://github.com/jbdoderlein/BetterOCaml/blob/master/src/serviceWorker.js), so this web app is now a *Progressive Web App* (PWA), which can be installed on your laptop and used later on, even if you're offline! After being intalled, the app should appear in your global application menu (it works on Chromium on both Windows and Ubuntu).
4846

49-
> If you can't install it as a PWA, [@Naereen](https://GitHub.com/Naereen) recommends trying [WebCatalog](https://webcatalog.app/), a multi-platform desktop app (for \*NIX, Windows and Mac OS), and you can then use it to "install" [the BetterOCaml editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml/?version=4.14.0), along with its integrated OCaml interpreter (of course), as a "native" desktop app. It then appears in the menu of your system, and it works offline! See [this 1:30min tutorial in video](https://github.com/jbdoderlein/BetterOCaml/issues/6#issuecomment-780269129).
47+
> If you can't install it as a PWA, [@Naereen](https://GitHub.com/Naereen) recommends trying [WebCatalog](https://webcatalog.app/), a multi-platform desktop app (for \*NIX, Windows and Mac OS), and you can then use it to "install" [the BetterOCaml editor](https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml), along with its integrated OCaml interpreter (of course), as a "native" desktop app. It then appears in the menu of your system, and it works offline! See [this 1:30min tutorial in video](https://github.com/jbdoderlein/BetterOCaml/issues/6#issuecomment-780269129).
5048
5149
### :phone: On a smartphone
5250
- It also works fine on smartphone running any recent OS and browser, :ok_hand: and the app should be "responsive" and you can switch to a vertical layout in the settings if your screen is too narrow.
@@ -59,12 +57,19 @@ If you have any suggestion for a new theme, [open an issue](https://github.com/j
5957
BetterOCaml is a fully installable Progressive Web App
6058

6159
[![pwa performance](https://betterocaml.ml/pwa_performance_2503.svg)](https://pagespeed-insights.herokuapp.com/?url=https://betterocaml.ml)
60+
6261
## OCaml version
63-
You can change the OCaml version with the url : `https://betterocaml.ml/?version=4.11.0`
6462

65-
Available version : `4.06.0`,`4.06.1`,`4.07.0`,`4.07.1`,`4.08.0`,`4.08.0`,`4.08.1`,`4.09.0`,`4.09.1`,`4.10.0`,`4.10.1`,`4.10.2`,`4.11.0`,`4.11.1`,`4.11.2`,`4.12.0`,`4.12.1`,`4.13.0`,`4.13.1`,`4.14.0`
63+
You can change the OCaml version with the url : `https://link-to-betterocaml/?version=4.11.0`
64+
65+
<https://perso.eleves.ens-rennes.fr/people/jean-baptiste.doderlein/betterocaml> offers `4.13.1`, `4.14.0` and `5.1.0`
6666

6767
You can also compile the toplevel with any version you want using [the compilation script](https://github.com/jbdoderlein/BetterOCaml/blob/master/toplevel_build/BUILD.md#how-to-build-the-betterocaml-toplevel).
68+
69+
Available version : `4.06.0`,`4.06.1`,`4.07.0`,`4.07.1`,`4.08.0`,`4.08.0`,`4.08.1`,`4.09.0`,`4.09.1`,`4.10.0`,`4.10.1`,`4.10.2`,`4.11.0`,`4.11.1`,`4.11.2`,`4.12.0`,`4.12.1`,`4.13.0`,`4.13.1`,`4.14.0`, `4.14.1`, `5.1.0`
70+
71+
*The dune configuration is now modified to work with Dune>3.0 and Ocaml 5.0, to compile for OCaml<5.0, use [this commit](https://github.com/jbdoderlein/BetterOCaml/commit/7e3f428305a3410d0212c1dbe15610170d9f76ed)*
72+
6873
## About this project
6974

7075
### :hammer_and_wrench: Dependencies

toplevel_build/BUILD.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# How to build the BetterOCaml Toplevel
2-
[![Maintenance](https://img.shields.io/badge/storage%20space%20required-1.3Gb-blue?style=flat-square)]()
2+
3+
**Warning** : The dune configuration is now modified to work with Dune>3.0 and Ocaml 5.0, to compile for OCaml<5.0, use [this commit](https://github.com/jbdoderlein/BetterOCaml/commit/7e3f428305a3410d0212c1dbe15610170d9f76ed)
4+
35
With the tool created by math-gout, you can easily compile the
46
OCaml toplevel used in BetterOCaml.
57
## Clone repository

0 commit comments

Comments
 (0)