The documentation should be structured better

livecode / atom-language-livecode

LiveCode Language package for Atom

GNU General Public License v3.0

16 stars 15 forks source link

The documentation should be structured better #19

Closed peter-b closed 8 years ago

peter-b commented 8 years ago

The top-level README file (which is also shown on the package page) needs to be more helpful. Specifically:

Installation instructions need to be more prominent, and need to link to the Atom documentation for "how to install packages". Optional dependency packages need to be listed with links to the appropriate packages' pages.
Add links to the package pages and/or documentation for Atom features that the package integrates with, including indentation, auto-completion, snippets, and linting.
Provide very basic instructions for downloading/extracting LiveCode Server for LCS linting support.

peter-b commented 8 years ago

Given the feedback on the 0.6.0 release our documentation is unclear enough to basically be a bug. :sob:

montegoulding commented 8 years ago

One option would be to include the server engine in the package so it works out of the box. It does mean maintaining that though.

peter-b commented 8 years ago

@montegoulding I don't think that it's very practical to include the server engine in the package :fearful:! I think the correct thing here is to make the server engine easier to install into the system path, possibly by proving both "Install Shell Commands" and "Install LiveCode Server" functions in the IDE somewhere. I've been meaning to file an IDE feature request for a while, so I'll make that a higher priority.

montegoulding commented 8 years ago

Yes please!

peter-b commented 8 years ago

@montegoulding livecode/livecode-ide#612