Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adjusted links in the markup
  • Loading branch information
ebresie authored May 14, 2022
1 parent 643dc6d commit 903f139
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
# python4nb

This is Python Plugin for Apache Netbeans which leverages textmate grammar and LSP based functionality.
This is Python Plugin for [Apache Netbeans](https://netbeans.apache.org/) which leverages textmate grammar and LSP based functionality.

The source is being published for further community support and development opportunities.

This is in early development with more work to follow.

Once more development is more mature, expectations is a release will be available here and/or be published to the Netbeans Python Plugin Portal ( https://plugins.netbeans.apache.org/ ).
Once more development is more mature, expectations is a release will be available here and/or be published to the [Netbeans Plugin Portal]( https://plugins.netbeans.apache.org/).

## Available Features:
- Python Colorization (via textmate gramer)
- Auto completion leveraging the Python LSP
- Python Hints/Tips leveraging the Python LSP

# How to install it
- Installation requires python ( https://www.python.org/ ) to be installed
- Installation requires [Python](https://www.python.org/) to be installed
- Installation of following python LSP related module to be installed in g
-- python -m pip install python-language-server[all]
--- For additional details on the LSP server, see https://pypi.org/project/python-language-server/
--- For additional details on the [Python LSP server](https://pypi.org/project/python-language-server/)
- Compile python4nb from source and install module within given Netbeans setup

# Change process
- Changes will be tracked using github issues (see https://github.com/ebresie/python4nb/issues ).
- Changes will be tracked using [project's github issues](https://github.com/ebresie/python4nb/issues).
- Upon completion of updates for given issues, a pull request will be made, reviewed, and upon completion integrated into the master branch in github for coming release.

# Change log
## For version, will attempt to comply with major/minor/patch versioning as defined here https://semver.org/
## Release 0.1
- Python Colorization (via textmate gramer)
- Auto completion leveraging the Python LSP
- Python Hints/Tips leveraging the Python LSP

## TODO (see https://github.com/ebresie/python4nb/issues ):
- Complete Python Project functionality (https://github.com/ebresie/python4nb/issues/8)
- Complete Python Platform Configuration and Installation (https://github.com/ebresie/python4nb/issues/3)
- Complete Python Execution Functionality (https://github.com/ebresie/python4nb/issues/4)
- Complete Python Debugging (https://github.com/ebresie/python4nb/issues/5)
- Complete Python Module Management (https://github.com/ebresie/python4nb/issues/6)
- Complete Unit Test functionality https://github.com/ebresie/python4nb/issues/7
- Complete Implement CI build/packaging for release https://github.com/ebresie/python4nb/issues/9
- Complete Help and documentation for the python4nb plugin https://github.com/ebresie/python4nb/issues/10
- Complete Development "New Project" Templates https://github.com/ebresie/python4nb/issues/11
## For version, will attempt to comply with major/minor/patch versioning as defined [here](https://semver.org/)

## TODO (For more speifics See [Issue area](https://github.com/ebresie/python4nb/issues):
- [Complete Python Project functionality](https://github.com/ebresie/python4nb/issues/8)
- [Complete Python Platform Configuration and Installation](https://github.com/ebresie/python4nb/issues/3)
- [Complete Python Execution Functionality](https://github.com/ebresie/python4nb/issues/4)
- [Complete Python Debugging](https://github.com/ebresie/python4nb/issues/5)
- [Complete Python Module Management](https://github.com/ebresie/python4nb/issues/6)
- [Complete Unit Test functionality](https://github.com/ebresie/python4nb/issues/7)
- [Complete Implement CI build/packaging for release](https://github.com/ebresie/python4nb/issues/9)
- [Complete Help and documentation for the python4nb plugin](https://github.com/ebresie/python4nb/issues/10)
- [Complete Development "New Project" Templates](https://github.com/ebresie/python4nb/issues/11)

# License
Project is being developed leveraging Apache-2.0 license ( https://github.com/ebresie/python4nb/blob/main/LICENSE ) or applicable licenses.
Project is being developed leveraging [Apache-2.0 license]( https://github.com/ebresie/python4nb/blob/main/LICENSE ) or applicable licenses.
All due dilligence has been made to attribute proper licensings where applicable.

Some functionality is based on or leverages functionality from other projects and attempts to comply as applicable.
Expand All @@ -52,5 +52,5 @@ Some functionality is based on or leverages functionality from other projects an
- https://pypi.org/project/python-language-server/

# Contributors
- Eric Bresie ( https://github.com/ebresie )
- [Eric Bresie](https://github.com/ebresie)

0 comments on commit 903f139

Please sign in to comment.