The Type Astronaut's Guide to Shapeless
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

The Type Astronaut's Guide to Shapeless

Copyright 2016 Dave Gurnell. Text and diagrams licensed CC-BY-SA 3.0. Code samples licensed Apache 2.0

Reading the Book

You have three options for grabbing the book:

Related Material

Accompanying code samples can be found here:
https://github.com/underscoreio/shapeless-guide-code

Check the solutions branch for complete versions of each example.

Building the eBook

Install Docker and use go.sh to boot an instance with most of the right dependencies:

bash$ ./go.sh

Then run npm install to install the remaining dependencies:

npm install

And finally use sbt to build the book:

sbt pdf

Building a printable book

To build a black and white, print-ready version of the book, edit src/meta/pdf.yaml and set blackandwhiteprintable to true. Then run sbt pdf as above.

Contributing

Please raise an issue or submit a PR. If you submit a PR, make sure to add yourself to src/pages/intro/constributors.md!

Acknowledgements

Thanks to Miles Sabin, Richard Dallaway, Noel Welsh, Travis Brown, and our fellow space-farers on Github for their invaluable help and feedback.