summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorbscan <10503608+bscan@users.noreply.github.com>2022-02-10 19:20:29 -0500
committerbscan <10503608+bscan@users.noreply.github.com>2022-02-10 19:20:29 -0500
commit607926c3a83f3976c47b0f5fd1e001f75f7537d7 (patch)
tree36d48d90108a586df5f8d5e6c84643ac85a2beb7 /README.md
parente191927ebb9038cb61927d32e3e630b55d9256a9 (diff)
downloadPerlNavigator-607926c3a83f3976c47b0f5fd1e001f75f7537d7.zip
Updating README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8ccef80..a357af4 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# Perl Navigator
+# Perl Navigator Language Server
Extension for Perl that includes syntax checking, perlcritic, and code navigation.
Implemented as a Language Server using the Microsoft LSP libraries along with Perl doing the syntax checking and parsing.
Works on Windows, MacOS, and Linux. The vscode extension includes everything needed to work, no additional installation should be necessary.
-Works on almost any version of Perl, tested all the way back to Perl 5.8. Has support for multi-root workspaces, single file editing, and multiple open windows.
+Works on almost any version of Perl, tested all the way back to Perl 5.8. Has full support for multi-root workspaces, single file editing, and multiple open windows.
## Currently Implemented Features:
@@ -13,7 +13,8 @@ Works on almost any version of Perl, tested all the way back to Perl 5.8. Has su
* Smart context-aware autocompletion and navigation
* Code Navigation ("Go To Definition") anywhere, including to installed modules and compile-time dependencies
* Outline view
-* List all modules under Workspace symbols
+* Hover for more details about objects, subs, and modules
+* Does not write any cache directories or temp files.
* Works well with single files and large multi-folder workspaces
* Support for Classes including Moo/Moose style classes
@@ -21,6 +22,7 @@ Works on almost any version of Perl, tested all the way back to Perl 5.8. Has su
## Installation
Install the VSCode extension and it should just work. All required dependencies are bundled with the extension.
Please file a bug report if the Perl Navigator does not work out of the box.
+Perl::Critic is not currently bundled and needs to be installed separately, but the remaining features (e.g. navigation, autocomplete, syntax check) do not require it.
### Perl paths
@@ -30,3 +32,8 @@ You can also add additional include paths that will be added to the perl search
### Customizable Perl Critic severities
The default severities are reasonable, but you can change "perlnavigator.severity1" through severity5. Allowable options are error, warning, info, and hint.
+
+
+## Licenses / Acknowledgments
+The Perl Navigator is free software licensed under the MIT License. It has a number of bundled dependencies as well, all of which have their respective open source licenses included.
+This work is only possible due to Class::Inspector, Devel::Symdump, Perl::Critic, PPI, Sub::Util, Perl itself, Microsoft LSP libraries, and ideas from Perl::LanguageServer and PLS. \ No newline at end of file