summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbscan <10503608+bscan@users.noreply.github.com>2023-09-23 12:40:30 -0400
committerbscan <10503608+bscan@users.noreply.github.com>2023-09-23 12:40:30 -0400
commita9d98dd40b90d88437d2c826666b6790b49d71c6 (patch)
tree624e64341a6f5093b4525b388be75b1e26f9d042
parent787379be0bb7263f74470708f50509c9962fa3bf (diff)
downloadPerlNavigator-a9d98dd40b90d88437d2c826666b6790b49d71c6.zip
Updating documentation
-rw-r--r--CONTRIBUTING.md12
-rw-r--r--README.md22
-rw-r--r--server/README.md9
3 files changed, 32 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d789ebc..134552c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,3 +21,15 @@ If you run this command by itself, you can see how the typescript side and the p
# Testing the Perl Navigator
If you want to run a full environment of the Navigator, you can check out the repo and use the built-in Run configurations. The navigator was originally a clone of the Microsoft language server example from here: https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample and includes the run configurations from it. It pops open a new window running the extension. For additional information, see the lsp-sample repo or feel reach out to me.
+
+
+## Building For VSCode/VSCodium
+You don't need to build the extension to be able to test and develop.
+In addition to node.js and npm you will have to install [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce), a tool for packaging (among other things) extensions in the .vsix format used by both VSCode and VSCodium by running the following:
+```sh
+git clone https://github.com/bscan/PerlNavigator
+cd PerlNavigator/
+npm install -g @vscode/vsce
+vsce package
+```
+At this point all that's left to do is install the resulting .vsix file (located in the current directory) in VSCode or VSCodium by navigating to the Extensions pane and choosing "Install from VSIX...".
diff --git a/README.md b/README.md
index 1a9c96e..bc3d2a5 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ Install the vscode extension from here: https://marketplace.visualstudio.com/ite
* Imports cleanup via perlimports
* Outline view
* Hover for more details about objects, subs, and modules
-* Syntax highlighting for Object::Pad, Moose, Zydeco, etc.
+* Syntax highlighting for Object::Pad, Moose, Zydeco, Dancer2, etc.
* Support for Classes including Moo/Moose style classes
## Visual Studio Code Demo
@@ -53,18 +53,20 @@ By default, perlimports is not enabled, but the diagnostics (linting) can be ena
Perlimports can be customized with a profile using the `perlnavigator.perlimportsProfile`.
Due to implementation limitations, perlimports requires a saved version of the file you are working on. If any results are unexpected, save the working file and try again.
-## Building For VSCode/VSCodium
-In addition to node.js and npm you will have to install [vsce](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce), a tool for packaging (among other things) extensions in the .vsix format used by both VSCode and VSCodium by running the following:
+
+## Installation For Other Editors
+### Using NPM
+The easiest way to install is using npm
```sh
-git clone https://github.com/bscan/PerlNavigator
-cd PerlNavigator/
-npm install -g @vscode/vsce
-vsce package
+sudo npm install -g perlnavigator-server
```
-At this point all that's left to do is install the resulting .vsix file (located in the current directory) in VSCode or VSCodium by navigating to the Extensions pane and choosing "Install from VSIX...".
+Which will install as /usr/bin/perlnavigator. This can be used as the command for most editors without any other arguments (i.e. --stdio can be omitted)
-## Installation For Other Editors
-Currently, this is not yet packaged for other editors but you can build from source. You'll need to have node.js and npm installed.
+### Using the binaries
+Alternatively you can download binary releases for Windows, Linux, and MacOS here: https://github.com/bscan/PerlNavigator/releases
+
+### Building from source
+You can also build from source if you prefer.
```sh
git clone https://github.com/bscan/PerlNavigator
cd PerlNavigator/
diff --git a/server/README.md b/server/README.md
index fac1ddc..65be4d0 100644
--- a/server/README.md
+++ b/server/README.md
@@ -1,9 +1,16 @@
# Perl Navigator Language Server
Provides syntax checking, autocompletion, perlcritic, code navigation, hover for Perl.
-
Implemented as a Language Server using the Microsoft LSP libraries along with Perl doing the syntax checking and parsing.
+## Installation
+The easiest way to install is using npm
+```sh
+sudo npm install -g perlnavigator-server
+```
+Which will install as /usr/bin/perlnavigator. This can be used as the command for most editors without any other arguments (i.e. --stdio can be omitted)
+
+
## Currently Implemented Features:
* Syntax Checking
* Perl Critic static code analysis/suggestions