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

Write tutorial #41

Closed
snowleopard opened this Issue Jan 5, 2018 · 4 comments

Comments

Projects
None yet
2 participants
@snowleopard
Owner

snowleopard commented Jan 5, 2018

Haddock is not sufficient. We need a beginner-friendly overview of the library with a few simple use-cases.

@nobrakal

This comment has been minimized.

Contributor

nobrakal commented Jul 1, 2018

So I have worked on https://github.com/nobrakal/alga-tutorial-traditional .

It is a tex file, but using pandoc and few css tricks, it can render in HTML. If it fits, I think the best place to store it is in github using https://pages.github.com/ .

I can generate the HTML now and store it in my repo if you don't want to mess the actual alga repo with this. Then you can add a submodule and directly use my repo to build the page: https://help.github.com/articles/using-submodules-with-pages/

@snowleopard

This comment has been minimized.

Owner

snowleopard commented Jul 2, 2018

@nobrakal Hosting on GitHub pages would be great!

I think it would be best if the tutorial lives in your repo and I simply link from Alga's README to the page.

@nobrakal

This comment has been minimized.

Contributor

nobrakal commented Jul 3, 2018

I changed the repo name to: https://github.com/nobrakal/alga-tutorial

And launched github pages at https://nobrakal.github.io/alga-tutorial/

@snowleopard

This comment has been minimized.

Owner

snowleopard commented Jul 7, 2018

@nobrakal I've linked to the tutorial from the README. Many thanks!

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