Skip to content

Commit 5bbe881

Browse files
gnikitgnikit
committed
Updates README
1 parent de9cdeb commit 5bbe881

File tree

1 file changed

+57
-49
lines changed

1 file changed

+57
-49
lines changed

‎README.md‎

Lines changed: 57 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,32 @@
1-
# Fortran Language Server - dev version
2-
3-
> This is the developer's version for @hansec's original `fortran-language-server`.
4-
> It contains bug fixes and new features that are yet to be merged into the main repository.
1+
# fortls - the Fortran Language Server
52

63
[![PyPI Latest Release](https://img.shields.io/pypi/v/fortls.svg)](https://pypi.org/project/fortls/)
74
[![Tests](https://github.com/gnikit/fortran-language-server/actions/workflows/main.yml/badge.svg)](https://github.com/gnikit/fortran-language-server/actions/workflows/main.yml)
8-
[![image](https://img.shields.io/github/license/hansec/fortran-language-server.svg)](https://github.com/hansec/fortran-language-server/blob/master/LICENSE)
5+
[![image](https://img.shields.io/github/license/gnikit/fortran-language-server.svg)](https://github.com/gnikit/fortran-language-server/blob/master/LICENSE)
96
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
107

11-
A Fortran implementation of the [Language Server
12-
Protocol](https://github.com/Microsoft/language-server-protocol) using
13-
Python (3.6+).
8+
`fortls`: A Fortran implementation of the [Language Server Protocol](https://github.com/Microsoft/language-server-protocol)
9+
(LSP) using Python (3.6+).
1410

15-
Editor extensions using this language server to provide autocomplete and
11+
Editor extensions that can integrate with `fortls` to provide autocomplete and
1612
other IDE-like functionality are available for
17-
[Atom](https://atom.io/packages/ide-fortran), [Visual Studio
18-
Code](https://marketplace.visualstudio.com/items?itemName=hansec.fortran-ls),
13+
[Visual Studio Code](https://github.com/krvajal/vscode-fortran-support)
14+
[Atom](https://atom.io/packages/ide-fortran),
1915
[Visual Studio](https://github.com/michaelkonecny/vs-fortran-ls-client),
2016
[(Neo)vim](https://github.com/hansec/fortran-language-server/wiki/Using-forts-with-vim),
2117
and [Emacs](https://github.com/emacs-lsp/lsp-mode).
2218

23-
## Language Server Features
19+
## fortls vs fortran-language-server
20+
21+
This project is based on @hansec's original Language Server implementation but the two projects have since diverged.
22+
`fortls` (this project) is now developed independently of the upstream `hansec/fortran-language-server` project and contains numerous bug fixes and new features
23+
the original `fortran-language-server` does not.
24+
25+
The name of executable for this project has been chosen to remain `fortls`
26+
to allow for integration with pre-existing plugins and workflows but it is
27+
potentially subject to change.
28+
29+
## Features
2430

2531
- Document symbols (`textDocument/documentSymbol`)
2632
- Auto-complete (`textDocument/completion`)
@@ -60,7 +66,7 @@ and [Emacs](https://github.com/emacs-lsp/lsp-mode).
6066
pip install fortls
6167
```
6268

63-
## Language server settings
69+
## fortls settings
6470

6571
The following global settings can be used when launching the language
6672
server.
@@ -101,16 +107,12 @@ server.
101107

102108
The following settings can be used to perform [standalone debug
103109
tests](https://github.com/hansec/fortran-language-server/wiki) on the
104-
language server.
105-
106-
- `--debug_filepath=DEBUG_FILEPATH` File path for language server
107-
tests
108-
- `--debug_rootpath=DEBUG_ROOTPATH` Root path for language server
109-
tests
110-
- `--debug_line=DEBUG_LINE` Line position for language server tests
111-
(1-indexed)
112-
- `--debug_char=DEBUG_CHAR` Character position for language server
113-
tests (1-indexed)
110+
fortls
111+
112+
- `--debug_filepath=DEBUG_FILEPATH` File path for fortls tests
113+
- `--debug_rootpath=DEBUG_ROOTPATH` Root path for fortls tests
114+
- `--debug_line=DEBUG_LINE` Line position for fortls (1-indexed)
115+
- `--debug_char=DEBUG_CHAR` Character position for fortls tests (1-indexed)
114116
- `--debug_full_result` Print full result object instead of condensed
115117
version
116118
- `--debug_parser` Test source code parser on specified file
@@ -195,7 +197,7 @@ back again one can do
195197
### Preprocessing
196198

197199
**Note:** Preprocessor support is not "complete", see below. For
198-
preprocessed files the language server will only analyze code within
200+
preprocessed files the `fortls` will only analyze code within
199201
preprocessor conditional regions if the conditional test can be
200202
evaluated by the server or if the region is the _default_ path (ie. a
201203
bare `#else` region).
@@ -243,49 +245,55 @@ right).
243245
}
244246
```
245247

246-
## Bug reports
247-
248-
When [filing
249-
bugs](https://github.com/hansec/fortran-language-server/issues/new)
250-
please provide example code to reproduce the observed issue.
251-
252-
## License
253-
254-
This project is made available under the [MIT
255-
License](https://github.com/hansec/fortran-language-server/blob/master/LICENSE).
256-
257-
## Support
258-
259-
If you _really_ like [this
260-
package](https://github.com/hansec/fortran-language-server) you can [buy
261-
me a coffee](https://paypal.me/hansec) to say thanks.
262-
263-
## Editor examples (Atom)
248+
<!-- ## Editor examples (Atom)
264249
265250
Document symbols (`textDocument/documentSymbol`):
266251
267-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_outline.png)
252+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_outline.png)
268253
269254
Auto-complete (`textDocument/completion`):
270255
271-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_autocomplete.gif)
256+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_autocomplete.gif)
272257
273258
Signature help (`textDocument/signatureHelp`):
274259
275-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_sigHelp.gif)
260+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_sigHelp.gif)
276261
277262
Goto definition (`textDocument/definition`):
278263
279-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_gotodef.gif)
264+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_gotodef.gif)
280265
281266
Hover (`textDocument/hover`):
282267
283-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_hover.gif)
268+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_hover.gif)
284269
285270
Find references (`textDocument/references`):
286271
287-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_refs.png)
272+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_refs.png)
288273
289274
Diagnostics:
290275
291-
![image](https://raw.githubusercontent.com/hansec/fortran-language-server/master/images/fortls_diag.png)
276+
![image](https://raw.githubusercontent.com/gnikit/fortran-language-server/master/images/fortls_diag.png) -->
277+
278+
## Acknowledgements
279+
280+
This project would not have been possible without the original work of [@hansec](https://github.com/hansec/)
281+
and the original [`fortran-language-server`](https://github.com/hansec/fortran-language-server)
282+
283+
## Support
284+
285+
If you want to support this project you can do it through
286+
287+
[![Alt](https://www.paypalobjects.com/webstatic/mktg/Logo/pp-logo-150px.png)](https://paypal.me/inikit)
288+
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/gnikit)
289+
290+
Support the original project go [here](https://paypal.me/hansec)
291+
292+
## Bug reports
293+
294+
When [filing bugs](https://github.com/gnikit/fortran-language-server/issues/new)
295+
please provide example code to reproduce the observed issue.
296+
297+
## License
298+
299+
This project is made available under the [MIT License](https://github.com/gnikit/fortran-language-server/blob/master/LICENSE).

0 commit comments

Comments
 (0)