underscoreio/shapeless-guide

Name: shapeless-guide

Owner: Underscore

Description: The Type Astronaut's Guide to Shapeless

Created: 2016-08-26 15:30:17.0

Updated: 2018-01-17 10:28:28.0

Pushed: 2018-01-08 15:20:10.0

Homepage: http://underscore.io/books/shapeless-guide

Size: 16082

Language: TeX

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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:

• grab an up-to-date PDF from dist/shapeless-guide.pdf (free);
• download the book from Underscore (also free) and get notified of future updates by email;
• order a print copy from Underscore.
• a french translation is also available

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:

$ ./go.sh

Then run npm install to install the remaining dependencies:

install

And finally use sbt to build the book:

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.