Skip to content
This repository was archived by the owner on Dec 23, 2017. It is now read-only.
This repository was archived by the owner on Dec 23, 2017. It is now read-only.

README.md doesn't explain very well what this package is for #3

@ghost

Description

The README.md doesn't explain very well what this package is for.
The things I am missing are:

  1. Is this package meant to be used directly by Atom users, or just as a base plugin for other plugin developers to create new language support packages more easily? (or both)

  2. If directly meant for Atom users, I am missing a section "Usage" before the "Architecture" section which explains things like: how do I add the path to the binary of a language server for my new language X to be processed with the plugin

  3. What exact parts of the language server protocol does this plugin provide for the end user? (linting, error checking, debugging, ... ?)

As a solution, I recommend expanding the top paragraph to something like this:

An implementation of the https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md for the atom editor.

It can be used both as a basis by plugin developers for new language support plugins for Atom, as well as directly by Atom end users for integrating existing language servers for use with their editor to get support for advanced editor features for new programming languages that don't have their own dedicated language-X Atom plugin yet.

Through any newly added language servers, this plugin will provide linting, error checking and debugging in the Atom editor for any new choice of programming language (given the specific language server chosen supports those features). As for adding new languages after installing this plugin in your Atom editor, see the "Usage" section below."

(or similar depending on what this plugin is actually made for)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions