search

eclipse-shellwax / shellwax

Shell script editor plugin for Eclipse
https://marketplace.eclipse.org/content/shellwax
Eclipse Public License 2.0
17 stars 12 forks source link

Little to no documentation #104

Closed kansasSamurai closed 9 months ago

kansasSamurai commented 10 months ago

Could you add a minimal explanation of what things are expected to look like and what features this has to your website and/or documentation? I like the idea of this project and have downloaded to a temporary Eclipse installation on Windows but I don't really know what to look for other than syntax highlighting on .sh files (or more correctly, shebang files).

If I'm overlooking something that already exists, simply point me to it. I did several different google searches and could not uncover anything. It seems like maybe there's a subset of Eclipse enthusiasts who wrote/use this but I think it would be more widely adopted if there was at least some documentation.

mickaelistria commented 9 months ago

As mentioned in https://github.com/eclipse/shellwax#bash-language-server , you should have most edition features working as usual for Eclipse IDE: hover on commands to get the man page, Ctrl+Space to get completion...

akurtakov commented 9 months ago

Documentation is in https://github.com/eclipse/shellwax/blob/master/README.md which is even shown if one goes to https://github.com/eclipse/shellwax . I hope this gives you a good start.

akurtakov commented 9 months ago

Closing this one . If you feel that more documentation is needed I would appreciate a PR for that.