Skip to content
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.

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

Add examples from Compose presentation to README #141

Open
hammer opened this issue Feb 4, 2016 · 2 comments
Open

Add examples from Compose presentation to README #141

hammer opened this issue Feb 4, 2016 · 2 comments

Comments

@hammer
Copy link
Contributor

hammer commented Feb 4, 2016

Having a quick example of how to use Oml from utop in the README would be nice. Bonus points for including your MNIST example as well.

@rleonid
Copy link
Owner

rleonid commented Feb 4, 2016

@hammer Would links to examples, maybe like a table of contents in the README suffice?

@smondet Do you think that oredoc would be a good fit here? I'd like to be able to easily transform the example scripts into documentation.

@smondet
Copy link
Contributor

smondet commented Feb 5, 2016

@rleonid oredoc can fransform ocaml code with special markdown comments into an HTML page with ocaml code-blocs:
https://github.com/hammerlab/ketrew/blob/master/src/test/Workflow_Examples.ml
http://seb.mondet.org/software/ketrew/Workflow_Examples.html
Happy to discuss adding features if that's not what you want :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants