| commit | author | age | ||
| 5cb5f7 | 1 | On-the-fly syntax checking for GNU Emacs 24. |
| C | 2 | |
| 3 | Flycheck is a modern on-the-fly syntax checking extension for GNU Emacs, | |
| 4 | intended as replacement for the older Flymake extension which is part of GNU | |
| 5 | Emacs. | |
| 6 | ||
| 7 | Flycheck automatically checks buffers for errors while you type, and reports | |
| 8 | warnings and errors directly in the buffer and in an optional IDE-like error | |
| 9 | list. | |
| 10 | ||
| 11 | It comes with a rich interface for custom syntax checkers and other | |
| 12 | extensions, and has already many 3rd party extensions adding new features. | |
| 13 | ||
| 14 | Please read the online manual at http://www.flycheck.org for more | |
| 15 | information. You can open the manual directly from Emacs with `M-x | |
| 16 | flycheck-manual'. | |
| 17 | ||
| 18 | # Setup | |
| 19 | ||
| 20 | Flycheck works best on Unix systems. It does not officially support Windows, | |
| 21 | but tries to maintain Windows compatibility and should generally work fine on | |
| 22 | Windows, too. | |
| 23 | ||
| 24 | To enable Flycheck add the following to your init file: | |
| 25 | ||
| 26 | (add-hook 'after-init-hook #'global-flycheck-mode) | |
| 27 | ||
| 28 | Flycheck will then automatically check buffers in supported languages, as | |
| 29 | long as all necessary tools are present. Use `flycheck-verify-setup' to | |
| 30 | troubleshoot your Flycheck setup. | |
