Skip to content

Commit 85368ad

Browse files
committed
Updates README
- Adds Anaconda install instructions - Adds links to Sponsors
1 parent a26f59b commit 85368ad

File tree

2 files changed

+55
-28
lines changed

2 files changed

+55
-28
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
- Added keywords to the PyPi manifest
88
([#99](https://github.com/gnikit/fortls/issues/99))
99

10+
### Changed
11+
12+
- Updated `README` to include conda-forge installation instructions
13+
1014
## 2.2.14
1115

1216
### Added

README.md

Lines changed: 51 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
[![GitHub license](https://img.shields.io/github/license/gnikit/fortls)](https://github.com/gnikit/fortls/blob/dev/LICENSE)
99
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1010

11+
[![GitHub Sponsor](https://img.shields.io/static/v1?style=social&label=Sponsor&message=%E2%9D%A4&logo=GitHub&color&link=%3Curl%3E)](https://github.com/sponsors/gnikit)
12+
[![PayPal](https://img.shields.io/static/v1?style=social&label=Donate&message=%E2%9D%A4&logo=Paypal&color&link=%3Curl%3E)](https://paypal.me/inikit)
13+
1114
`fortls` is an implementation of the [Language Server Protocol](https://github.com/Microsoft/language-server-protocol)
1215
(LSP) for Fortran using Python (3.7+).
1316

@@ -16,24 +19,11 @@ All code editors that support LSP can integrate with `fortls` see the section
1619
Some supported code editors include:
1720
[Visual Studio Code](https://gnikit.github.io/fortls/editor_integration.html#visual-studio-code),
1821
[Atom](https://gnikit.github.io/fortls/editor_integration.html#atom),
19-
[Sublime Text](https://gnikit.github.io/fortls/editor_integration.html#sublime-text)
22+
[Sublime Text](https://gnikit.github.io/fortls/editor_integration.html#sublime-text),
2023
[(Neo)Vim](https://gnikit.github.io/fortls/editor_integration.html#vim-neovim-gvim),
21-
[Visual Studio](https://gnikit.github.io/fortls/editor_integration.html#visual-studio-2017),
24+
[Visual Studio](https://gnikit.github.io/fortls/editor_integration.html#visual-studio-2017)
2225
and [Emacs](https://gnikit.github.io/fortls/editor_integration.html#emacs).
2326

24-
## `fortls` vs `fortran-language-server`
25-
26-
This project is based on @hansec's original Language Server implementation but the two projects have since diverged.
27-
`fortls` (this project) is now developed independently of the upstream `hansec/fortran-language-server` project and contains numerous bug fixes and new features
28-
the original `fortran-language-server` does not.
29-
30-
For a complete and detailed list of the differences between the two Language Servers
31-
see the Documentation section: [Unique fortls features (not in fortran-language-server)](https://gnikit.github.io/fortls/fortls_changes.html)
32-
33-
The name of executable for this project has been chosen to remain `fortls`
34-
to allow for integration with pre-existing plugins and workflows but it is
35-
potentially subject to change.
36-
3727
## Features
3828

3929
- Project-wide and Document symbol detection and Renaming
@@ -68,20 +58,55 @@ potentially subject to change.
6858

6959
- Signature help and hover does not handle elegantly overloaded functions i.e. interfaces
7060

61+
## `fortls` vs `fortran-language-server`
62+
63+
This project was originally based on `fortran-language-server` LSP implementation, but the two projects have since diverged.
64+
65+
`fortls` (this project) is now developed independently of the upstream `hansec/fortran-language-server` project and contains numerous new features and bug fixes
66+
the original `fortran-language-server` does not.
67+
68+
For a complete and detailed list of the differences between the two Language Servers
69+
see the Documentation section: [Unique fortls features (not in fortran-language-server)](https://gnikit.github.io/fortls/fortls_changes.html)
70+
71+
The name of executable for this project has been chosen to remain `fortls`
72+
to allow for integration with pre-existing plugins and workflows, but it could
73+
change in the future.
74+
7175
## Installation
7276

77+
### PyPi
78+
7379
```sh
7480
pip install fortls
7581
```
7682

77-
> **Warning**: it is not recommended having `fortls` and `fortran-language-server`
78-
> simultaneously installed, since they use the same binary name. If you are having trouble
79-
> getting `fortls` to work try uninstalling `fortran-language-server` and reinstalling `fortls`.
80-
>
81-
> ```sh
82-
> pip uninstall fortran-language-server
83-
> pip install fortls --upgrade
84-
> ```
83+
### Anaconda
84+
85+
```sh
86+
conda install -c conda-forge fortls
87+
```
88+
89+
for more information about the Anaconda installation [see](https://github.com/conda-forge/fortls-feedstock#about-fortls)
90+
91+
### Common installation problems
92+
93+
It is **NOT** recommended having `fortls` and `fortran-language-server`
94+
simultaneously installed, since they use the same binary name. If you are having trouble
95+
getting `fortls` to work try uninstalling `fortran-language-server` and reinstalling `fortls`.
96+
97+
With `pip`
98+
99+
```sh
100+
pip uninstall fortran-language-server
101+
pip install fortls --upgrade
102+
```
103+
104+
or with Anaconda
105+
106+
```sh
107+
conda uninstall fortran-language-server
108+
conda install -c conda-forge fortls
109+
```
85110

86111
## Settings
87112

@@ -129,16 +154,14 @@ An example for a Configuration file is given below
129154
## Acknowledgements
130155

131156
This project would not have been possible without the original work of [@hansec](https://github.com/hansec/)
132-
and the original [`fortran-language-server`](https://github.com/hansec/fortran-language-server)
157+
in [`fortran-language-server`](https://github.com/hansec/fortran-language-server)
133158

134-
## Support
159+
<!-- ## Support
135160
136161
If you want to support this project you can do it through
137162
138163
[![Alt](https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-150px.png)](https://paypal.me/inikit)
139-
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/gnikit)
140-
141-
Support the original project go [here](https://paypal.me/hansec)
164+
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/gnikit) -->
142165

143166
## Bug reports
144167

0 commit comments

Comments
 (0)