branch: externals/phps-mode commit 8707777eaf2d6696fe1684702b969b11ce258468 Author: Christian Johansson <christ...@cvj.se> Commit: Christian Johansson <christ...@cvj.se>
Updated README --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d1793b7..171da9c 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,27 @@ An Emacs major mode for PHP scripting language which aims at making a full semantic integration. Currently at *usable* stage. +This mode does not require PHP installed on computer because it has a elisp based lexer and parser. It supports all PHP versions. + ## Goals *With current progress estimates:* -* Flycheck support (100%) +* GPLv3 license (100%) +* Flycheck support (PHP Mess Detector, PHP Code Sniffer) (100%) * Syntax coloring based on lexer tokens (100%) -* PSR based indentation based on lexer tokens (100%) +* PSR-1 and PSR-2 indentation based on lexer tokens (100%) * Lexer based on official PHP re2c lexer (100%) * Imenu support (100%) * Incremental lexer and syntax coloring after buffer changes (75%) -* Wisent LALR parser based on official PHP yacc parser automatically converted (50%) +* Wisent LALR parser based on official PHP yacc parser automatically converted grammar (50%) * Full integration with Emacs Semantic subsystem (30%) -* GPLv3 license (0%) * Flymake support (0%) * PSR-2 auto-formatting tool based on lexer tokens (0%) * Travis support (0%) * Add to MELPA (0%) * Add to ELPA (0%) -* Use master branch for stable releases and develop for unstable (0%) +* From first stable release, use master branch for stable releases and develop branch for on-going work (0%) ## Unit tests @@ -46,7 +48,7 @@ make test-parser ### Functions -Indentations, imenu. +Indentations, incremental processes, Imenu-support. ``` bash make test-functions @@ -54,7 +56,7 @@ make test-functions ### Integration tests -Not ready yet +This should test all other parts in collaboration. Not ready yet ``` bash make test-integration @@ -70,6 +72,8 @@ make tests Download to `~/.emacs.d/phps-mode/` and then add this to your init file: +### Using use-package + ``` emacs-lisp (add-to-list 'load-path (expand-file-name "~/.emacs.d/phps-mode/")) (use-package phps-mode