https://github.com/underscoreio/shapeless-guide

The Type Astronaut's Guide to Shapeless
https://github.com/underscoreio/shapeless-guide

Last synced: 4 months ago
JSON representation

The Type Astronaut's Guide to Shapeless

• Host: GitHub
• URL: https://github.com/underscoreio/shapeless-guide
• Owner: underscoreio
• Created: 2016-08-26T15:30:17.000Z (over 8 years ago)
• Default Branch: develop
• Last Pushed: 2019-02-11T06:09:53.000Z (about 6 years ago)
• Last Synced: 2024-08-02T12:23:50.674Z (7 months ago)
• Language: TeX
• Homepage: http://underscore.io/books/shapeless-guide
• Size: 16 MB
• Stars: 759
• Watchers: 46
• Forks: 73
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# The Type Astronaut's Guide to Shapeless

Copyright 2016 Dave Gurnell.

Text and diagrams licensed [CC-BY-SA 3.0][text-license].

Code samples licensed [Apache 2.0][code-license]

## Reading the Book

You have three options for grabbing the book:

- read/download the book at the [Underscore][underscore] web site;

- order a print copy from [Underscore][underscore];

- a french translation is [also available][fr].

## 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][contributors]

for their invaluable help and feedback.

[text-license]: https://creativecommons.org/licenses/by-sa/3.0/

[code-license]: http://www.apache.org/licenses/LICENSE-2.0

[shapeless]: https://github.com/milessabin/shapeless

[pdf]: https://github.com/underscoreio/shapeless-guide/blob/develop/dist/shapeless-guide.pdf

[slides]: https://github.com/davegurnell/shapeless-guide-slides

[code]: https://github.com/underscoreio/shapeless-guide-code

[contributors]: https://github.com/underscoreio/shapeless-guide/graphs/contributors

[underscore]: https://underscore.io/books/shapeless-guide

[lulu]: http://www.lulu.com/shop/dave-gurnell/the-type-astronauts-guide-to-shapeless/paperback/product-22992219.html

[fr]: https://github.com/crakjie/shapeless-guide