Skip to content

Commit 0b6ce7f

Browse files
committed
clean up the docs
1 parent b9cbc69 commit 0b6ce7f

File tree

1 file changed

+7
-40
lines changed

1 file changed

+7
-40
lines changed

README.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6,49 +6,16 @@ SublimeLinter-html-tidy
66
This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to tidy (either the [html4](http://tidy.sourceforge.net) or [html5](http://w3c.github.io/tidy-html5/) version). It will be used with files that have the “HTML” syntax.
77

88
## Installation
9-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](http://sublimelinter.readthedocs.org/en/latest/installation.html).
9+
SublimeLinter must be installed in order to use this plugin.
1010

11-
### Linter installation
12-
Before installing this plugin, you must ensure that `tidy` or `tidy5` are installed on your system. If both are installed, `tidy5` will be utilised.
11+
Please install via [Package Control](https://sublime.wbond.net/installation).
1312

14-
- **Mac OS X**`tidy` comes preinstalled on recent versions of Mac OS X. You can install the [html5](https://github.com/w3c/tidy-html5) version by using [Homebrew](http://brew.sh) and `brew install tidy-html5`, or it can be built and installed from source.
13+
Before installing this plugin, you must ensure that `tidy` or `tidy5` are installed on your system. `tidy5` will be used over `tidy` id available.
1514

16-
- **Linux**You should be able to install tidy using the system’s package manager. For example, on systems which use APT (such as Debian or its derivations), tidy can be installed with `sudo apt-get install tidy`. The experimental [html5](https://github.com/w3c/tidy-html5) version can be built and installed from source.
15+
- **Mac OS X**`tidy` comes preinstalled on recent versions of Mac OS X. You can install the [html5](https://github.com/w3c/tidy-html5) version by using [Homebrew](http://brew.sh) and `brew install tidy-html5`.
1716

18-
- **Windows**Windows binaries are available for both the [stable](http://www.paehl.com/open_source/?HTML_Tidy_for_Windows), and experimental [html5](http://tidybatchfiles.info/) versions.
17+
- **Linux**You should be able to install tidy using the system’s package manager.
1918

20-
### Linter configuration
21-
In order for `tidy` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in [“Finding a linter executable”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
19+
- **Windows** – Windows binaries are available for the [html5](http://tidybatchfiles.info/) version.
2220

23-
Once `tidy` is installed and configured, you can proceed to install the SublimeLinter-tidy plugin if it is not yet installed.
24-
25-
### Plugin installation
26-
Please use [Package Control](https://sublime.wbond.net/installation) to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
27-
28-
To install via Package Control, do the following:
29-
30-
1. Within Sublime Text, bring up the [Command Palette](http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html) and type `install`. Among the commands you should see `Package Control: Install Package`. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
31-
32-
1. When the plugin list appears, type `html-tidy`. Among the entries you should see `SublimeLinter-html-tidy`. If that entry is not highlighted, use the keyboard or mouse to select it.
33-
34-
## Settings
35-
For general information on how SublimeLinter works with settings, please see [Settings](http://sublimelinter.readthedocs.org/en/latest/settings.html). For information on generic linter settings, please see [Linter Settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
36-
37-
`tidy` must be configured via command line arguments. You can use the `"args"` linter setting to pass arguments to tidy.
38-
39-
## Contributing
40-
If you would like to contribute enhancements or fixes, please do the following:
41-
42-
1. Fork the plugin repository.
43-
1. Hack on a separate topic branch created from the latest `master`.
44-
1. Commit and push the topic branch.
45-
1. Make a pull request.
46-
1. Be patient. ;-)
47-
48-
Please note that modifications should follow these coding guidelines:
49-
50-
- Indent is 4 spaces.
51-
- Code should pass flake8 and pep257 linters.
52-
- Vertical whitespace helps readability, don’t be afraid to use it.
53-
54-
Thank you for helping out!
21+
In order for `tidy` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter.

0 commit comments

Comments
 (0)