search

hdgarrood / purescript-numeric-hierarchy-guide

Sources for https://a-guide-to-the-purescript-numeric-hierarchy.readthedocs.io/en/latest/
36 stars 4 forks source link

readme

purescript-numeric-hierarchy-guide

Sources for https://a-guide-to-the-purescript-numeric-hierarchy.readthedocs.io/en/latest/.

Status

This guide is currently in a beta stage.

ReadTheDocs builds the HTML from what's in the published branch; the master branch will often be slightly ahead of published, containing material that I feel is not quite ready to be published yet.

If you read through an earlier version of this guide and want to see what has changed in the meantime, there is a changelog. There is also GitHub's compare view. For example, this view compares what's in the published branch now with what published looked like 2 days ago.

Contributions

I am very happy to receive feedback to help improve this guide - so please feel free to email me or open issues.

However, please do not send me pull requests. I have decided to not accept contributions because it makes copyright issues simpler; I would like to retain full copyright ownership of this work, in case I ever want to publish it as a book or anything like that.

License

Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

This work is licensed under CC BY-NC-SA 4.0 — that is, the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. This means you are free to copy and redistribute it as well as make changes, but you must give credit, link to the license, and indicate if changes were made. The license also forbids commercial use.

Note that the work is not necessarily exclusively licensed under CC BY-NC-SA 4.0. In particular, if you're worried about whether your use of it counts as a commercial use please contact me and we'll probably be able to sort something out.

Working on this locally

this is really just a note for me, please see the above paragraph re: contributions

Compiled using Sphinx. I have been developing on Ubuntu using the default version from the Ubuntu repositories; install like this:

$ sudo apt install python3-sphinx

At the time of writing, on Ubuntu 16.04, this gets you Sphinx v1.3.6. The hosting is done by Read The Docs; I'm not sure what version of Sphinx they're using, but it seems to work fine between both environments.

To rebuild, change to the project directory and run:

$ make html

The html will be written to the _build directory; I recommend spinning up a simple HTTP server in there to use whilst developing. The npm package serve can provide this.