branch: scratch/editorconfig-cc
commit e3e3a90e9d4462aed6affda6b49257789d1a1a0a
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Update README to help bootstrap users (#219)
* Update README to help bootstrap users
* Update doc
* Fix doc
* Update
* Updat
---
README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++----------------
1 file changed, 47 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 3a4857af12..7618464dac 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,33 @@
[](http://melpa.org/#/editorconfig)
[](https://stable.melpa.org/#/editorconfig)
-## Setup
+# EditorConfig Emacs Plugin
+
+## Getting Started
+
+
+### Install from MELPA
This package is available from [MELPA][] and [MELPA Stable][].
-Install from there and enable global minor-mode `editorconfig-mode`:
+Install from these repositories and enable global minor-mode
`editorconfig-mode`:
```emacs-lisp
(editorconfig-mode 1)
```
+Normally, enabling `editorconfig-mode` should be enough for this plugin to
work:
+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
-To install manually, copy all `.el` files in this repository to
-`~/.emacs.d/lisp` and add the following:
+
+### Manual installation
+
+Copy all `.el` files in this repository to `~/.emacs.d/lisp` and add the
+following:
```emacs-lisp
(add-to-list 'load-path "~/.emacs.d/lisp")
@@ -20,18 +35,6 @@ To install manually, copy all `.el` files in this repository
to
(editorconfig-mode 1)
```
-### (Optional) Install a Core Program
-
-This package uses a Core program.
-A core implemented in Emacs Lisp is include in this plugin,
-so usually you don't need to install any other core programs.
-
-Optionally, you can install and use other core programs.
-One such example is [EditorConfig C Core][], follow the instructions
-in the README and INSTALL files to install it.
-To use them instead of the default elisp core, you need to configure
-`editorconfig-get-properties-function`
-(read the docstring for details).
## Supported properties
@@ -140,6 +143,34 @@ init.el:
```
+## Troubleshooting
+
+Enabling `editorconfig-mode` should be enough for normal cases.
+
+When EditorConfig properties are not effective for unknown reason, we recommend
+first trying `M-x editorconfig-display-current-properties`.
+
+This command will open a new buffer and display the EditorConfig properties
+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
+requires explicit support for each major-mode for `indent_size` property.
+
+By default this plugin ships with settings for many major-modes, but,
+sorry to say, it cannot be perfect. Especially it is difficult to support
+brand-new major-modes.
+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`.
+
+
+
### Development
