-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(vscode): add dedicated readme for the extension
- Loading branch information
Showing
2 changed files
with
23 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# 🍲 Mabo - Visual Studio Code Extension | ||
|
||
Data format and schema, with a type system as strong as Rust's. | ||
|
||
This project is currently still in a _pre-alpha_ stage and undergoing many changes until the first alpha release. Nonetheless, it should already be usable from the Rust side but expect breaking changes often. | ||
|
||
For further details about how to get started, the schema language or anything else, please consult the official [project website](https://dnaka91.github.io/mabo/). | ||
|
||
## Using the extension | ||
|
||
Currently this extension doesn't bundle the necessary LSP binary. If you have Rust installed, you can use Cargo to build the LSP: | ||
|
||
```sh | ||
cargo install --git https://github.com/dnaka91/mabo.git mabo-lsp | ||
``` | ||
|
||
Then, make sure the binary is globally accessible by putting the Cargo binary folder to your `$PATH` environment variable. This is usually located at `~/.cargo/bin`. | ||
|
||
## License | ||
|
||
This project is licensed under [MIT License](LICENSE.md) (or <http://opensource.org/licenses/MIT>). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters