Build Status Agda agda-stdlib

Getting Started with PLFA

There are several tools you need to work with PLFA:

For most of the tools, you can simply follow their respective build instructions. We list the versions of our dependencies on the badges above. We have tested with the versions listed; either earlier or later versions may cause problems.

You can get the appropriate version of Programming Language Foundations in Agda from Github, either by cloning the repository, or by downloading the zip archive:

git clone https://github.com/plfa/plfa.github.io 

Finally, we need to let Agda know where to find the standard library. For this, you can follow the instructions here.

It is possible to set up PLFA as an Agda library as well. If you want to complete the exercises found in the courses folder, or to import modules from the book, you need to do this. To do so, add the path to plfa.agda-lib to ~/.agda/libraries and add plfa to ~/.agda/defaults, both on lines of their own.

Unicode characters

If you’re having trouble typing the Unicode characters into Emacs, the end of each chapter should provide a list of the unicode characters introduced in that chapter. For a full list of supported characters, see agda-input.el.

Using agda-mode

?            hole
{!...!}      hole with contents
C-c C-l      load buffer

Command to give when in a hole:

C-c C-c x    split on variable x
C-c C-space  fill in hole
C-c C-r      refine with constructor
C-c C-a      automatically fill in hole
C-c C-,      Goal type and context
C-c C-.      Goal type, context, and inferred type

See the emacs-mode docs for more details.

If you want to see messages beside rather than below your Agda code, you can do the following:

  • Load your Agda file and do C-c C-l;
  • type C-x 1 to get only your Agda file showing;
  • type C-x 3 to split the window horizontally;
  • move your cursor to the right-hand half of your frame;
  • type C-x b and switch to the buffer called “Agda information”

Now, error messages from Agda will appear next to your file, rather than squished beneath it.

Fonts in Emacs

It is recommended that you add the following to the end of your emacs configuration file at ~/.emacs, if you have the mentioned fonts available:

;; Setting up Fonts for use with Agda/PLFA
;;
;; default to DejaVu Sans Mono, 
(set-face-attribute 'default nil
		    :family "DejaVu Sans Mono"
		    :height 120
		    :weight 'normal
		    :width  'normal)

;; fix \:
(set-fontset-font "fontset-default"
		  (cons (decode-char 'ucs #x2982)
			(decode-char 'ucs #x2982))
		  "STIX")

Building the book

To build and host a local copy of the book, there are several tools you need in addition to those listed above:

For most of the tools, you can simply follow their respective build instructions. Most recent versions of Ruby should work. You install the Ruby dependencies—Jekyll, html-proofer, etc.—using Bundler:

bundle install

Once you have installed all of the dependencies, you can build a copy of the book by running:

make build

You can host your copy of the book locally by running:

make serve

The Makefile offers more than just these options:

make                      (see make test)
make build                (builds lagda->markdown and the website)
make build-incremental    (builds lagda->markdown and the website incrementally)
make test                 (checks all links are valid)
make test-offline         (checks all links are valid offline)
make serve                (starts the server)
make server-start         (starts the server in detached mode)
make server-stop          (stops the server, uses pkill)
make clean                (removes all ~unnecessary~ generated files)
make clobber              (removes all generated files)

If you simply wish to have a local copy of the book, e.g. for offline reading, but don’t care about editing and rebuilding the book, you can grab a copy of the master branch, which is automatically built using Travis. You will still need Ruby and Bundler to host the book (see above). To host the book this way, download a copy of the master branch, unzip, and from within the directory run

bundle install
bundle exec jekyll serve

Markdown

The book is written in Kramdown Markdown.

Travis Continuous Integration

You can view the build history of PLFA at travis-ci.org.