New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to use preludes in the README #352

Open

samoht opened this issue Oct 22, 2021 · 1 comment

Collaborator

samoht commented Oct 22, 2021 •

edited

Loading

It would be nice to summarise what the tests are doing in the REAMDE, e.g.

you can either use a file and pass --prelude x.ml to mdx like in https://github.com/realworldocaml/mdx/tree/main/test/bin/mdx-test/expect/prelude-file
or pass an OCaml expression directly to mdx e.g. --prelude-str "let x = 3" like in https://github.com/realworldocaml/mdx/blob/main/test/bin/mdx-test/expect/prelude

And you can choose to load the prelude on one one environnement with --prelude "env:file.ml"

The text was updated successfully, but these errors were encountered:

Member

yminsky commented Oct 22, 2021

Would also be good to document how to invoke said features from Dune.

sorawee mentioned this issue

Revamp README #442

Draft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment