Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix up the SublimeText README #237

Merged
merged 1 commit into from
Oct 17, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 0 additions & 68 deletions plugins/sublime/README.md

This file was deleted.

19 changes: 7 additions & 12 deletions plugins/sublime/SublimeLinter-contrib-proselint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ SublimeLinter-contrib-proselint
================================

[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-proselint.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-proselint)
very unique
This linter plugin for [SublimeLinter][docs] provides an interface to [proselint](__linter_homepage__). It will be used with files that have the “__syntax__” syntax.

This linter plugin for [SublimeLinter][docs] provides an interface to [proselint](http://proselint.com). It will be used with files that have the “markdown”, “text”, or “plain text” syntaxes.

## Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation].
abbeviatable

### Linter installation
Before using this plugin, you must ensure that `proselint` is installed on your system. To install `proselint`, do the following:

Expand All @@ -18,8 +19,7 @@ Before using this plugin, you must ensure that `proselint` is installed on your
[sudo] pip install proselint
```


**Note:** This plugin requires `proselint` __version__ or later.
**Note:** This plugin requires `proselint` 0.3.4 or later.

### Linter configuration
In order for `proselint` 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.
Expand All @@ -38,17 +38,12 @@ To install via Package Control, do the following:
## Settings
For general information on how SublimeLinter works with settings, please see [Settings][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings].

In addition to the standard SublimeLinter settings, SublimeLinter-contrib-proselint provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline][inline-settings].

|Setting|Description|Inline Setting|Inline Override|
|:------|:----------|:------------:|:-------------:|
|foo|Something.|✓| |
|bar|Something else.| |✓|
In addition to the standard SublimeLinter settings, SublimeLinter-contrib-proselint provides its own settings through a config file, `.proselintrc`.

## Contributing
If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
1. Fork the main repository, http://github.com/amperser/proselint.
1. Hack on a separate topic branch created from the latest `master`.
1. Commit and push the topic branch.
1. Make a pull request.
Expand All @@ -59,7 +54,7 @@ Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
- Please use descriptive variable names, no abbreviations unless they are well known.

Thank you for helping out!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This linter plugin for SublimeLinter provides an interface to proselint.
Before this plugin will activate, you *must*
follow the installation instructions here:

https://github.com/Jordan Suchow/SublimeLinter-contrib-proselint
https://github.com/amperser/SublimeLinter-contrib-proselint