5.3 KiB
Emacs mode for lean theorem prover
Requirements
lean-mode requires Emacs 24 and the following
packages, which can be installed via M-x package-install.
The following packages are optional, but we recommend installing them
to use full features of lean-mode.
Both the optional and required packages will be installed for you
automatically the first time you use lean-mode, if you follow the
installation instructions below.
Installation
Put the following elisp code in your emacs setup
(e.g. .emacs.d/init.el [GNU Emacs], ~/Library/Preferences/Aquamacs Emacs/Preferences.el [Aquamacs]) :
(require 'package)
(add-to-list 'package-archives '("gnu" . "http://elpa.gnu.org/packages/") t)
(add-to-list 'package-archives '("melpa" . "http://melpa.milkbox.net/packages/") t)
(package-initialize)
;; Install required/optional packages for lean-mode
(defvar lean-mode-required-packages
'(company dash dash-functional flycheck f
fill-column-indicator s lua-mode mmm-mode))
(let ((need-to-refresh t))
(dolist (p lean-mode-required-packages)
(when (not (package-installed-p p))
(when need-to-refresh
(package-refresh-contents)
(setq need-to-refresh nil))
(package-install p))))
Please choose your installation method from the following scenarios, and add the elisp code to your emacs setup:
Case 1: Build Lean from source
;; Set up lean-root path
(setq lean-rootdir "~/projects/lean") ;; <=== YOU NEED TO MODIFY THIS
(setq-local lean-emacs-path
(concat (file-name-as-directory lean-rootdir)
(file-name-as-directory "src")
"emacs"))
(add-to-list 'load-path (expand-file-name lean-emacs-path))
(require 'lean-mode)
Case 2: Install Lean via apt-get on Ubuntu or via dpkg on Debian
;; Set up lean-root path
(setq lean-rootdir "/usr")
(setq-local lean-emacs-path "/usr/share/emacs/site-lisp/lean")
(add-to-list 'load-path (expand-file-name lean-emacs-path))
(require 'lean-mode)
Case 3: Install Lean via homebrew on OS X
;; Set up lean-root path
(setq lean-rootdir "/usr/local")
(setq-local lean-emacs-path "/usr/local/share/emacs/site-lisp/lean")
(add-to-list 'load-path (expand-file-name lean-emacs-path))
(require 'lean-mode)
Note: if you install homebrew in a custom location that is not the default
location, please run brew info lean, and it will tell you where the
lean-mode files are located. With that information, update the
lean-emacs-path variable accordingly.
Case 4: Install Lean in Windows
;; Set up lean-root path
(setq lean-rootdir "\\lean-0.2.0-windows")
(setq-local lean-emacs-path "\\lean-0.2.0-windows\\share\\emacs\\site-lisp\\lean")
(add-to-list 'load-path (expand-file-name lean-emacs-path))
(require 'lean-mode)
Key Bindings
| Key | Function |
|---|---|
| C-c C-x | lean-std-exe |
| C-c C-l | lean-std-exe |
| C-c C-t | lean-eldoc-documentation-function |
| C-c C-f | lean-fill-placeholder |
| M-. | lean-find-tag |
| TAB | lean-tab-indent-or-complete |
| C-c C-o | lean-set-option |
| C-c C-e | lean-eval-cmd |
Known Issues and Possible Solutions
Unicode
If you experience a problem reading unicode characters on emacs,
first consider using a unicode-friendly font such as DejaVu Sans Mono:
(when (member "DejaVu Sans Mono" (font-family-list))
(set-face-attribute 'default nil :font "DejaVu Sans Mono-11"))
If you still experience a rendering problem, consider trying emacs-unicode-fonts:
- Install
unicode-fontspackage by runningM-x package-refresh-contentsandM-x package-install. - Add the following lines in your emacs setup:
(require 'unicode-fonts) (unicode-fonts-setup)
Contributions
=============
Contributions are welcome!
If your contribution is a bug fix, create your topic branch from
`master`. If it is a new feature, check if there exists a
WIP(work-in-progress) branch (`vMAJOR.MINOR-wip`). If it does, use
that branch, otherwise use `master`.
Install [Cask](https://github.com/cask/cask) if you haven't already,
then:
$ cd /path/to/lean/src/emacs
$ cask
Run all tests with:
$ make