fluencelabs/aqua-vscode
1
0
Fork 0
mirror of https://github.com/fluencelabs/aqua-vscode synced 2025-03-14 13:20:51 +00:00
Code Issues Projects Releases Wiki Activity

docs: README minor update (#26)

Browse Source
This commit is contained in:
mikhail-1e20 2023-02-22 08:17:26 +03:00 committed by GitHub
parent 7998503155
commit 16701cf166
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,13 @@
## Contribute Code
You are welcome to contribute to Fluence!
Things you need to know:
1. You need to **agree to the [Contributor License Agreement](https://gist.github.com/fluencelabs-org/3f4cbb3cc14c1c0fb9ad99d8f7316ed7) (CLA)**. This is a common practice in all major Open Source projects. At the current moment, we are unable to accept contributions made on behalf of a company. Only individual contributions will be accepted.
2. **Not all proposed contributions can be accepted**. Some features may, e.g., just fit a third-party add-on better. The contribution must fit the overall direction of Fluence and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the contribution you plan to make.
### Contributor License Agreement
When you contribute, you have to be aware that your contribution is covered by **[Apache License 2.0](./LICENSE)**, but might relicensed under few other software licenses mentioned in the **Contributor License Agreement**. In particular, you need to agree to the Contributor License Agreement. If you agree to its content, you simply have to click on the link posted by the CLA assistant as a comment to the pull request. Click it to check the CLA, then accept it on the following screen if you agree to it. The CLA assistant will save this decision for upcoming contributions and will notify you if there is any change to the CLA in the meantime.

2
LICENSE
View File

@ -198,4 +198,4 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.

73
README.md
View File

@ -1,56 +1,53 @@
# aqua syntax highlighting
# Aqua Syntax Highlighting
Syntax highlighting for `aqua` programming language
The tool enables syntax highlighting for [Aqua](https://github.com/fluencelabs/aqua) programming language, compilation on file changes, and go-to definition in Visual Studio.
## Installation
1. Install [the extension](https://marketplace.visualstudio.com/items?itemName=FluenceLabs.aqua)
2. Configure colors for aqua-specific tokens if needed (see below)
## Installation and Usage
Add the following lines to the [settings.json](https://code.visualstudio.com/docs/getstarted/settings) file. Feel free
to choose colors according to you favorite theme. In the example below services will be highlighted as green and all the
keywords which affect the topology will be highlighted as red
Installation is pretty simple:
```json
"editor.tokenColorCustomizations": {
"textMateRules": [
{
"scope": "keyword.topology.aqua",
"settings": {
"foreground": "#FF0000",
1. Install [the extension](https://marketplace.visualstudio.com/items?itemName=FluenceLabs.aqua).
2. Configure colors for Aqua-specific tokens if needed (see below).
Add the following lines to the [`settings.json`](https://code.visualstudio.com/docs/getstarted/settings) file. Feel free to choose colors according to your favorite theme. In the example below, services will be highlighted as green and all keywords that affect the topology will be highlighted as red.
```json
"editor.tokenColorCustomizations": {
"textMateRules": [
{
"scope": "keyword.topology.aqua",
"settings": {
"foreground": "#FF0000",
}
},
{
"scope": "support.service.aqua",
"settings": {
"foreground": "#00FF00",
}
}
},
{
"scope": "support.service.aqua",
"settings": {
"foreground": "#00FF00",
}
}
]
}
```
]
}
```
## What is aqua?
More details can be found [here](vsc-extension-quickstart.md).
Aqua is a new-gen language for distributed systems.
NOTE: if you're going to change pattern names, check out the naming rules in [TextMate Grammar doc](https://macromates.com/manual/en/language_grammars). You have to use the predefined pattern naming scheme, or the syntax won't be highlighted.
Aqua programs are executed on many peers, sequentially or in parallel, forming a single-use coordination network.
Aqua's runtime is heterogeneous: it includes browsers, servers, devices, all involved in solving a single task.
Therefore, Aqua scripts are compiled into several targets at once, with AIR and Typescript as a default.
## Support
## Features
Please, file an [issue](https://github.com/fluencelabs/aqua-vscode/issues) if you find a bug. You can also contact us at [Discord](https://discord.com/invite/5qSnPZKh7u) or [Telegram](https://t.me/fluence_project). We will do our best to resolve the issue ASAP.
Enables syntax highlighting for `aqua` programming language, compilation on file changes, go-to-definition.
## Developing
## Contributing
see [vsc-extension-quickstart.md](vsc-extension-quickstart.md)
Any interested person is welcome to contribute to the project. Please, make sure you read and follow some basic [rules](./CONTRIBUTING.md).
NOTE: if you're going to change pattern names, check out the naming rules
in [TextMate Grammar doc](https://macromates.com/manual/en/language_grammars). You have to use predefined pattern naming
scheme, or the syntax won't be highlighted.
## License
[Apache 2.0](LICENSE)
All software code is copyright (c) Fluence Labs, Inc. under the [Apache-2.0](./LICENSE) license.