Skip to content

Commit

Permalink
Clarify post-install behaviour (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
PyvesB committed Jan 6, 2021
1 parent b0713a5 commit a7004d7
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@

Check out what's new in the [latest releases](https://github.com/PyvesB/eclipse-solargraph/releases)!


## :cd: Plugin installation

You can download and install the plugin via the [Eclipse Marketplace](https://marketplace.eclipse.org/content/ruby-solargraph/), or simply drag the below button to your running Eclipse workspace:
Expand All @@ -55,20 +54,20 @@ You can download and install the plugin via the [Eclipse Marketplace](https://ma

Alternatively, head to the [update site](https://pyvesb.github.io/eclipse-solargraph/) and follow the instructions listed there.

Once installed, the plugin will simply kick in when opening any Ruby file in Eclipse; there is no Ruby-specific project type or perspective.

## :sparkles: Tips and tricks

To improve code completion and intellisense, it is recommended to generate YARD documentation for your gems (run `yard gems` in a terminal).

You can fine-tune Solargraph's behaviour on a per-project basis by [creating a .solargraph.yml configuration file](https://solargraph.org/guides/configuration).


## :star: Support and feedback

Found a problem or need some help? Simply open an [**issue**](https://github.com/PyvesB/eclipse-solargraph/issues)!

Find the project useful or interesting? **Star** the repository by clicking on the icon on the top right of this page!


## :computer: Code contributions

Want to make this plugin better, faster, stronger? Contributions are more than welcome, open a **pull request** and share your CSS!
Expand All @@ -82,7 +81,6 @@ Setting up your own working copy of the project is easy:
* Open `eclipse-solargraph-target-platform.target` and click `Set as Active Target Platform`.
* You're ready to go! You can now either launch an instance of Eclipse running the plugin by right-clicking on the plugin project and selecting `Run As` -> `Eclipse Application`, or you can export a plugin archive file by selecting `Export` -> `Deployable plug-ins and fragments`.


## :balance_scale: License and acknowledgements

Eclipse Solargraph licensed under Eclipse Public License - v 2.0.
Expand Down

0 comments on commit a7004d7

Please sign in to comment.