Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
_cabal_deps/ | H | 03-May-2022 | - | 27,729 | 17,486 | |
docs/ | H | 03-May-2022 | - | 506 | 307 | |
html/ | H | 03-May-2022 | - | |||
src/ | H | 03-May-2022 | - | 18,422 | 12,353 | |
LICENSE | H A D | 09-Sep-2001 | 1.5 KiB | 31 | 25 | |
README.md | H A D | 09-Sep-2001 | 2.3 KiB | 20 | 13 | |
Setup.hs | H A D | 09-Sep-2001 | 46 | 3 | 2 | |
cabal.project | H A D | 03-May-2022 | 489 | 15 | 14 | |
shake.cabal | H A D | 03-May-2022 | 15.1 KiB | 507 | 480 |
README.md
1# Shake [![Hackage version](https://img.shields.io/hackage/v/shake.svg?label=Hackage)](https://hackage.haskell.org/package/shake) [![Stackage version](https://www.stackage.org/package/shake/badge/nightly?label=Stackage)](https://www.stackage.org/package/shake) [![Build status](https://img.shields.io/github/workflow/status/ndmitchell/shake/ci/master.svg)](https://github.com/ndmitchell/shake/actions) 2 3Shake is a tool for writing build systems - an alternative to make, Scons, Ant etc. Shake has been used commercially for over five years, running thousands of builds per day. The website for Shake users is at [shakebuild.com](https://shakebuild.com). 4 5#### Documentation 6 7* **Why use Shake?** Shake lets you write large robust build systems, which deal properly with generated source files and run quickly. If you are writing a custom build system of any moderate size (more than a few rules) you should use Shake. The advantages over other build systems are detailed in the document [Why choose Shake?](https://shakebuild.com/why). 8* **How do I use Shake?** Shake is a Haskell library that you use to define your rules. The [Shake manual](https://shakebuild.com/manual) provides a walk through of a small but realistic example, assuming no Haskell knowledge. 9* [Generated documentation](https://hackage.haskell.org/packages/archive/shake/latest/doc/html/Development-Shake.html) for all functions, includes lots of examples. 10* [Blog posts](https://neilmitchell.blogspot.co.uk/search/label/shake) detailing ongoing development work. 11* [Academic paper](https://ndmitchell.com/downloads/paper-shake_before_building-10_sep_2012.pdf) on the underlying principles behind Shake. 12 13#### Other links 14 15* [Download the Haskell package](https://hackage.haskell.org/package/shake) from Hackage and install it using Cabal. 16* [Mailing list](https://groups.google.com/forum/?fromgroups#!forum/shake-build-system) for any questions/bugs/thoughts on Shake. If you need more information and aren't sure where to start, use the mailing list. 17* [Questions](https://stackoverflow.com/questions/tagged/shake-build-system) can be asked on StackOverflow with the tag `shake-build-system`. 18 19Is your company using Shake? Write something public (even just a [tweet to `@ndm_haskell`](https://twitter.com/ndm_haskell)) and I'll include a link [on the website](https://shakebuild.com/#who-uses-shake). 20