madlang 3.1.1.1 → 3.1.1.6
raw patch · 3 files changed
+56/−27 lines, 3 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
Files
- README.md +18/−18
- madlang.cabal +1/−1
- man/madlang.1 +37/−8
README.md view
@@ -15,29 +15,30 @@ ## Installation -### Stack--Download `stack` with+### Binary Releases -```-curl -sSL http://haskellstack.org | sh-```+Head over to the [releases+page](https://github.com/vmchale/madlang/releases/latest) and grab a binary for+your platform. -Then run `stack install madlang --resolver nightly`. This is the recommended way-to install `madlang`, but it may take awhile.+### Cabal -### Nix+If you do not see you platform listed, you will have to install from source.+Download [cabal](https://www.haskell.org/cabal/download.html) and+[GHC](https://www.haskell.org/ghc/download.html). Then: -If you're on linux or mac, you can get binaries via nix.+```bash+ $ cabal update+ $ cabal install madlang+``` -Download nix with+You may need to add `$HOME/.cabal/bin` to your `PATH`. To do so: ```-curl https://nixos.org/nix/install | sh+ $ echo 'export PATH=$HOME/.cabal/bin:$PATH' >> $HOME/.bashrc+ $ source $HOME/.bashrc ``` -From there, `nix-env -i madlang` will install the executable.- ## Tutorial The smallest program possible in Madlang is simply a return declaration, viz.@@ -118,12 +119,11 @@ include libraries in a file. Open the following and save it as `gambling.mad`: ```madlang+:library+ :define coin 1.0 "heads" 1.0 "tails"--:return- 1.0 "" ``` Then, open the following and save it in the same directory as@@ -133,7 +133,7 @@ :include gambling.mad :define realisticGambling- 1.0 coin+ 1.0 gambling-coin 0.03 "on its side" :return
madlang.cabal view
@@ -1,5 +1,5 @@ name: madlang-version: 3.1.1.1+version: 3.1.1.6 synopsis: Randomized templating language DSL description: Madlang is a text templating language written in Haskell, meant to explore computational creativity and generative
man/madlang.1 view
@@ -14,6 +14,8 @@ madlang check <file> .PP madlang get <repo>+.PP+madlang sample <repo> .SH DESCRIPTION .PP \f[B]madlang\f[] is an interpreted language for generative literature@@ -39,13 +41,21 @@ Place files in $HOME/.madlang for them to be available globally as libraries. You can also download prebundled packages using-.PP-madlang install+.IP+.nf+\f[C]+madlang\ install+\f[]+.fi .SH EDITOR INTEGRATION .PP You can install a vim plugin for Madlang using-.PP-madlang vim+.IP+.nf+\f[C]+madlang\ vim+\f[]+.fi .PP Alternately, it is available from .PP@@ -53,15 +63,23 @@ .SH LIBRARIES .PP You can install third\-party libraries with-.PP-madlang get user/repo+.IP+.nf+\f[C]+madlang\ get\ user/repo+\f[]+.fi .PP The library will then be installed to $HOME/.madlang/repo .SH MODIFIERS .PP Strings in madlang can be followed by modifiers, for instance-.PP-1.0 "evil".oulipo+.IP+.nf+\f[C]+1.0\ "evil".oulipo+\f[]+.fi .PP Currently supported modifiers are: .IP \[bu] 2@@ -74,6 +92,17 @@ reverse .IP \[bu] 2 oulipo (removes all instances of the letter \[aq]e\[aq])+.SH DISPLAYING TREES+.PP+You may wish to use the command+.IP+.nf+\f[C]+madlang\ tree\ file.mad\ |\ less+\f[]+.fi+.PP+for larger trees. .SH EXAMPLES .PP You can examine an example using the bundled libraries at