diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 0000000..8b689f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -0,0 +1,21 @@ +# yamllint disable rule:line-length +--- +name: ๐Ÿž Bug +description: File a bug/issue +title: '[BUG] ' +assignees: ['piotr-semenov'] +labels: ['Bug'] +body: + - type: textarea + attributes: + label: PARI/GP syntax markup + description: Example of wrong syntax markup of your PARI/GP code. + validations: + required: false + - type: textarea + attributes: + label: Any other problem (installation issues, build failures, etc.) + description: | + Anything about the issue you are encountering: description, screenshots, etc. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml new file mode 100644 index 0000000..13a4060 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -0,0 +1,24 @@ +# yamllint disable rule:line-length +--- +name: ๐Ÿ’ก Feature +description: Suggest an idea to enhance this project +title: '[Feature] <title>' +assignees: ['piotr-semenov'] +labels: ['Enhancement'] +body: + - type: textarea + id: feature-proposal + attributes: + label: What would you like to add to this project? + description: Description of the feature or enhancement wanted. + placeholder: My feature proposal here... + validations: + required: true + - type: textarea + id: feature-reason + attributes: + label: Why is this needed? + description: Please, provide the use case example why you need this feature. + placeholder: Your feature use case example here... + validations: + required: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1362361..1125137 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -37,7 +37,7 @@ repos: name: lints yaml entry: yamllint language: system - files: '.*\.(yaml|YAML-tmLanguage)' + files: '.*\.(yaml|yml|YAML-tmLanguage)' # xml - repo: local hooks: diff --git a/README.md b/README.md index f195bea..8ea783b 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,67 @@ -<!-- markdownlint-disable MD033 --> -# PARI/GP Programming Language - +<!-- markdownlint-disable MD041 MD033 --> <p align="center"> - A Textmate language grammar for programming language of PARI/GP computer algebra system. - <br /> - <a href="https://github.com/piotr-semenov/parigp-lang/issues/new?labels=bug&assignees=piotr-semenov">Report bug</a> - ยท - <a href="https://github.com/piotr-semenov/parigp-lang/issues/new?labels=enhancement">Request feature</a> - <br /> - <img alt="Grammar Coverage" src="https://raw.githubusercontent.com/piotr-semenov/parigp-lang/main/images/coverage-badge.svg" height="20" /> - <a href="http://pari.math.u-bordeaux.fr/"><img alt="PARI/GP Logo" src="http://pari.math.u-bordeaux.fr/site_icons/PARI-GP-small.png" height="20" border="1" /></a> + <h2 align="center">PARI/GP Programming Language</h2> + <p align="center"> + A Textmate language grammar for programming language of PARI/GP computer algebra system. + <br /> + <a href="https://github.com/piotr-semenov/parigp-lang/issues/new?template=1-bug.yml">Report bug</a> + ยท + <a href="https://github.com/piotr-semenov/parigp-lang/issues/new?template=2-feature.yml">Request feature</a> + <br /> + <img alt="Grammar Coverage" src="https://raw.githubusercontent.com/piotr-semenov/parigp-lang/main/images/coverage-badge.svg" height="20" /> + <a href="http://pari.math.u-bordeaux.fr/"><img alt="PARI/GP Logo" src="http://pari.math.u-bordeaux.fr/site_icons/PARI-GP-small.png" height="20" border="1" /></a> + <a href="https://matrix.to/#/#parigp-lang:gitter.im"><img alt="Join the chat" src="https://badges.gitter.im/Join%20Chat.svg" height="20" /></a> + </p> </p> ## Table of Contents -- [Install into Visual Studio Code](#install-into-visual-studio-code) -- [Install into Sublime Text 3](#install-into-sublime-text-3) +- [Use in Visual Studio Code](#use-in-visual-studio-code) + - [How to install](#vsix-how-to-install) + - [What's included in package](#vsix-whats-included-in-package) +- [Use in Sublime Text](#use-in-sublime-text) + - [How to install](#st-how-to-install) + - [What's included in package](#st-whats-included-in-package) +- [How to build on your own](#how-to-build-on-your-own) +- [Creators](#creators) + +## Use in Visual Studio Code + +### <a id="vsix-how-to-install"></a> How to install + +Some text. + +### <a id="vsix-whats-included-in-package"></a> What's included in package + +```text +folder1/ +โ””โ”€โ”€ folder2/ + โ”œโ”€โ”€ folder3/ + โ”‚ โ”œโ”€โ”€ file1 + โ”‚ โ””โ”€โ”€ file2 + โ””โ”€โ”€ folder4/ + โ”œโ”€โ”€ file3 + โ””โ”€โ”€ file4 +``` + +## Use in Sublime Text + +Some text. + +### <a id="st-how-to-install"></a> How to install + +Some text. + +### <a id="st-whats-included-in-package"></a> What's included in package + +Some text. + +## How to build on your own + +```bash +VER=23.11 vagrant up +``` -## Install into Visual Studio Code +## Creators -## Install into Sublime Text 3 +- <https://github.com/piotr-semenov/>