From 6f54974a658634d1e8139f95894137aadfb4a57d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20Rogn=C3=A5s=20=F0=9F=8C=B1?= Date: Tue, 3 Sep 2024 08:49:33 +0200 Subject: [PATCH] Update README.md --- README.md | 60 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 72f6423..e72f1dd 100644 --- a/README.md +++ b/README.md @@ -7,35 +7,47 @@ A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marke ## Installation -To install the extension, open the Extensions view, search for `nonmem` to filter results and select NMTRAN extension. +To install the extension, open the Extensions view, search for `nonmem` to filter results and select the NMTRAN extension. -## Overview of the extension features +## Declarative Language Features -### Syntax highlighting - -![demo_syntax-highlight](images/demo_syntax-highlight.png) - -### Snippets - -![demo_advan-snippets](images/demo_advan-snippets.gif) +* Comment toggling using the VS Code command `Toggle Line Comment` +* Folding (by control records) +* Bracket matching +* Bracket autoclosing +* Bracket autosurrounding -Snippets for RUV (normal or log-scale): -* RUV_add -* RUV_prop -* RUV_addprop +### Syntax Highlighting -Snippets for MIXTURE-models (just type $MIX): -* 2-way mixture model -* 3-way mixture model +By tokenization according to [TextMate 1.5.1 naming conventions](https://macromates.com/manual/en/language_grammars#naming_conventions) -Snippets for creating an Xpose-friendly $TABLE scaffold (just type $TABLE). +![demo_syntax-highlight](images/demo_syntax-highlight.png) -Snippet for including IIV on a parameter that is bound between 0 and 1 (type logit_iiv). +### Snippet Completion -### Declarative Language Features +![demo_advan-snippets](images/demo_advan-snippets.gif) -* Comment toggling using the VS Code command `Toggle Line Comment` -* Autoclosing of brackets +#### Snippets +* Subroutine selection + * ADVAN and TRANS +* Modify `$DATA` on-the-fly (Credit: Simon Buatois) +* RUV (normal or log-scale) + * RUV_add + * RUV_prop + * RUV_addprop +* Creating an Xpose-friendly $TABLE scaffold (just type $TABLE). +* MIXTURE-models (just type $MIX) + * 2-way mixture model + * 3-way mixture model +* Including IIV on a parameter that is bound between 0 and 1 (type logit_iiv). +* Baseline modeling (B1, B2, B3, B4) [Dansirikul et al., 2008](https://doi.org/10.1007/s10928-008-9088-2) +* BQL modeling (M3) [Beal, 2001](https://doi.org/10.1023/a:1012299115260) + +## Programmatic Language Features + +* Diagnostics +* Code completion proposals +* Hover info ## Requirements @@ -43,8 +55,10 @@ VSCode v1.80.0 ## Contributing -We encourage your contribution to the project. You can report issues and post suggestions of features via [GitHub issues](https://github.com/vrognas/vscode-nmtran/issues). Thank you! +Your contribution to the project is encouraged. +You can report issues and post suggestions of features via [GitHub issues](https://github.com/vrognas/vscode-nmtran/issues). +Thank you! ## License -[MIT](LICENSE) \ No newline at end of file +[MIT](LICENSE)