From: Anders Mörtberg Date: Sun, 25 Oct 2015 22:05:39 +0000 (-0400) Subject: Merge branch 'improve-Makefile' of https://github.com/DanGrayson/cubicaltt into DanGr... X-Git-Url: https://git.ak3n.com/?a=commitdiff_plain;h=5619181e7f2586edaf49566a20b83fba7fa7a6c2;p=cubicaltt.git Merge branch 'improve-Makefile' of https://github.com/DanGrayson/cubicaltt into DanGrayson-improve-Makefile Conflicts: README.md --- 5619181e7f2586edaf49566a20b83fba7fa7a6c2 diff --cc README.md index 38137b0,8466c9d..9b4f46e --- a/README.md +++ b/README.md @@@ -28,19 -28,12 +28,22 @@@ For more examples, see "examples/demo.c Install ------- -To compile the program type: +To compile the project using [cabal](https://www.haskell.org/cabal/), +first install the build-time dependencies (either globally or in a +cabal sandbox): + + `cabal install alex happy bnfc` + +Then the project can be built (and installed): + + `cabal install` + +Alternatively, a `Makefile` is provided: - `make bnfc && make` + ```sh + make + ``` + This assumes that the following Haskell packages are installed: @@@ -58,10 -64,19 +74,25 @@@ To enable the debugging mode add the - type :h to get a list of available commands. Note that the current directory will be taken as the search path for the imports. ++ +When using cabal sandboxes, `cubical` can be invoked using + + `cabal exec cubical ` + ++ + To enable emacs to edit ```*.ctt``` files in ```ctt-mode```, add the following + line to your ```.emacs``` file: + ``` + (autoload 'ctt-mode "cubicaltt" "cubical editing mode" t) + (setq auto-mode-alist (append auto-mode-alist '(("\\.ctt$" . ctt-mode)))) + ``` + and ensure that the file ```cubicaltt.el``` is visible in one of the diretories + on emacs' ```load-path```, or else load it in advance, either manually with + ```M-x load-file```, or with something like the following line in ```.emacs```: + ``` + (load-file "cubicaltt.el") + ``` + References and notes --------------------