branch: scratch/editorconfig-cc
commit 645660fa9aabd0c97b0e2cfa017e52c9925a410e
Author: Jen-Chieh Shen <[email protected]>
Commit: Stefan Monnier <[email protected]>
docs(README.md): Update development instructions (#291)
---
README.md | 38 ++++++++++++++------------------------
1 file changed, 14 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index 0a1c73c7bd..20d48fec4f 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,6 @@
## Getting Started
-
### package.el
This package is available from [MELPA][], [MELPA Stable][] and [NonGNU ELPA][].
@@ -22,7 +21,6 @@ all other configurations are optional.
This mode sets up hooks so that EditorConfig properties will be
loaded and applied to the new buffers automatically when visiting files.
-
### use-package
@@ -37,24 +35,21 @@ following:
(editorconfig-mode 1)
```
-
-
## Supported properties
* `charset`
* `max_line_length`
-* <del>`file_type_ext` (Experimental)</del> (See below)
-* <del>`file_type_emacs` (Experimental)</del> (See below)
+* ~~`file_type_ext` (Experimental)~~ (See below)
+* ~~`file_type_emacs` (Experimental)~~ (See below)
-### <del>File Type (file_type_ext, file_type_emacs)</del>
+### ~~File Type (file_type_ext, file_type_emacs)~~
File-type feature is currently disabled, because this package is now undergoing
big internal refactoring.
For those who want this functionality,
please consider using
[editorconfig-custom-majormode](https://github.com/10sr/editorconfig-custom-majormode-el).
-
## Customize
`editorconfig-emacs` provides some customize variables.
@@ -62,7 +57,6 @@ please consider using
[editorconfig-custom-majormode](https://github.com/10sr/ed
Here are some of these variables: for the full list of available variables,
type <kbd>M-x customize-group [RET] editorconfig [RET]</kbd>.
-
### `editorconfig-trim-whitespaces-mode`
Buffer local minor-mode to use to trim trailing whitespaces.
@@ -81,7 +75,6 @@ init.el:
'ws-butler-mode)
```
-
### `editorconfig-after-apply-functions`
(Formerly `editorconfig-custom-hooks`)
@@ -98,8 +91,6 @@ only blocks of `web-mode` by adding following to your init.el:
(lambda (props) (setq web-mode-block-padding 0)))
```
-
-
## Troubleshooting
Enabling `editorconfig-mode` should be enough for normal cases.
@@ -112,8 +103,6 @@ loaded for current buffer.
You can check if EditorConfig properties were not read for buffers at all,
or they were loaded but did not take effect for some other reasons.
-
-
### Indentation for new major-modes
Because most Emacs major-modes have their own indentation settings, this plugin
@@ -127,7 +116,6 @@ Please feel free to submit issue or pull-request for such
major-mode!
Supported major-modes and their indentation configs are defined in the variable
`editorconfig-indentation-alist`.
-
### Not work at all for FOO-mode!
Most cases properties are loaded just after visiting files when
@@ -139,7 +127,6 @@ Typically it will occur when the major-mode is not defined
using
`define-derived-mode` (`rpm-spec-mode` is an example for this).
Please feel free to submit issues if you find such modes!
-
### `editorconfig-format-buffer` does not work well with lsp-mode
By default, [lsp-mode][] configures indent-region-function so that Emacs uses
@@ -150,24 +137,27 @@ themselves support loading configs from `.editorconfig`.
To avoid this behavior ad-hocly, set `lsp-enable-indentation` to nil.
+### Development
+To run the test locally, you will need the following tools:
+- Make
+- [CMake][]
+- [Eask][]
-### Development
+If you are on `Linux` or `macOS`:
-Make and [CMake][] must be installed to run the tests
-locally:
+ $ make check-unix
- $ make check
+On `Windows`:
+
+ $ make check-dos
To start a new Emacs process with current `*.el` and without loading user init
file, run:
$ make sandbox
-
-
-
## License
EditorConfig Emacs Plugin is free software: you can redistribute it
@@ -184,7 +174,6 @@ You should have received a copy of the GNU General Public
License along
with this program. If not, see <http://www.gnu.org/licenses/>.
-
[Emacs]: https://www.gnu.org/software/emacs/
[MELPA]: https://melpa.org/#/editorconfig
[MELPA Stable]: https://stable.melpa.org/#/editorconfig
@@ -194,4 +183,5 @@ with this program. If not, see
<http://www.gnu.org/licenses/>.
[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core-c
[properties]: https://editorconfig.org/#supported-properties
[CMake]: https://cmake.org
+[Eask]: https://github.com/emacs-eask/cli
[lsp-mode]: https://github.com/emacs-lsp/lsp-mode
