History

Soonho Kong 27ae03878c refactor(emacs/lean-server): rename flush-changed-lines to server-flush-changed-lines		2014-09-12 14:25:08 -07:00
..
features	test(emacs/features): add ecukes template	2014-09-11 12:33:49 -07:00
test	refactor(emacs): move tests in *.el files to 'test' directory	2014-09-11 12:29:32 -07:00
.gitignore	feat(emacs/Cask): add Cask file	2014-09-09 15:11:57 -07:00
Cask	chore(emacs/Cask): add ert-runner, ecukes	2014-09-11 11:12:05 -07:00
CMakeLists.txt	feat(emacs): include lean-mode Emacs files in the distribution	2014-01-09 11:50:07 -08:00
eri.el	feat(emacs/eri.el): add eri.el (from agda mode)	2014-08-30 14:57:34 -07:00
lean-cmd.el	refactor(emacs): move tests in *.el files to 'test' directory	2014-09-11 12:29:32 -07:00
lean-company.el	refactor(emacs/debug): rename lean-server-debug to lean-debug	2014-09-12 14:25:08 -07:00
lean-debug.el	refactor(emacs/debug): rename lean-server-debug to lean-debug	2014-09-12 14:25:08 -07:00
lean-flycheck.el	feat(emacs/lean-flycheck): "real" .clean file instead of "flycheck_real.clean"	2014-09-08 23:49:02 -07:00
lean-info.el	refactor(emacs/debug): rename lean-server-debug to lean-debug	2014-09-12 14:25:08 -07:00
lean-input.el	chore(emacs): minor adjustments to synthax hightlight and input mode	2014-09-06 08:32:05 -07:00
lean-mmm-lua.el	feat(emacs/lean-mmm-lua.el): add mmm-mode to syntax-highlight lua code	2014-09-02 10:37:03 -07:00
lean-mode.el	feat(emacs/lean-project): add lean-project-create to imenu	2014-09-10 15:19:11 -07:00
lean-option.el	feat(emacs): use lean-server-send-cmd-async	2014-09-04 16:32:07 -07:00
lean-project.el	feat(emacs/lean-project): add lean-project-create to imenu	2014-09-10 15:19:11 -07:00
lean-require.el	feat(emacs/lean-require): check lean-mode dependencies in initialization	2014-09-09 15:11:57 -07:00
lean-server.el	refactor(emacs/lean-server): rename flush-changed-lines to server-flush-changed-lines	2014-09-12 14:25:08 -07:00
lean-settings.el	feat(emacs/lean-mode): add imenu support	2014-09-09 09:04:31 -07:00
lean-syntax.el	feat(frontends/lean): add proof-qed expression	2014-09-11 18:14:49 -07:00
lean-tags.el	refactor(emacs/debug): rename lean-server-debug to lean-debug	2014-09-12 14:25:08 -07:00
lean-type.el	refactor(emacs/lean-server): rename flush-changed-lines to server-flush-changed-lines	2014-09-12 14:25:08 -07:00
lean-util.el	feat(emacs/lean-tags): try to find TAGS file upward and use it without asking	2014-08-26 16:22:32 -07:00
lean-variable.el	feat(emacs/lean-cmd): add FINDG cmd	2014-09-08 16:04:19 -07:00
README.md	doc(emacs/README.md): add contribution section	2014-09-11 12:29:00 -07:00

README.md

lean-mode

Emacs mode for lean theorem prover

Requirement

lean-mode requires Emacs 24 and following packages which can be installed via M-x package-install.

The following packages are optional but we recommend to install them to use full features of lean-mode.

Install

Put the following elisp code on your emacs setup (e.g. .emacs.d/init.el):

(require 'package)
(add-to-list 'package-archives
             '("melpa" . "http://melpa.milkbox.net/packages/") t)
(package-initialize)
(package-refresh-contents)

;; Install required/optional packages for lean-mode
(defvar lean-mode-required-packages
  '(company dash dash-functional flycheck whitespace-cleanup-mode
    fill-column-indicator s lua-mode mmm-mode))
(dolist (p lean-mode-required-packages)
  (when (not (package-installed-p p))
    (package-install p)))

;; Set up lean-root path
(setq lean-rootdir "~/projects/lean")
(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)

;; Customization for lean-mode
(customize-set-variable 'lean-delete-trailing-whitespace t)
(customize-set-variable 'lean-flycheck-use t)
(customize-set-variable 'lean-eldoc-use t)

If experience a problem reading unicode characters on emacs, consider having the following setup:

(when (member "DejaVu Sans Mono" (font-family-list))
  (set-face-attribute 'default nil :font "DejaVu Sans Mono-11"))

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

Contribution

Contribution is 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 if you haven't already, then:

$ cd /path/to/lean/src/emacs
$ cask

Run all tests with:

$ make