From 13f829d2ec2f635a126ccb5d772bb9d7903a963a Mon Sep 17 00:00:00 2001 From: KtorZ Date: Thu, 10 Nov 2022 15:10:11 +0100 Subject: [PATCH 1/2] Add .editorconfig, covering only *.ak file for now. --- .editorconfig | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..0759674c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.ak] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true From deab41b9e1cb7a396af3e543711b098dbbe433de Mon Sep 17 00:00:00 2001 From: KtorZ Date: Thu, 10 Nov 2022 15:46:58 +0100 Subject: [PATCH 2/2] Add 'getting-started' first draft. Mostly to have a place to list editors integrations. --- book/src/SUMMARY.md | 1 + book/src/getting-started.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 book/src/getting-started.md diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 8800aba4..4acb3abb 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -1,6 +1,7 @@ # Summary - [Introduction](./introduction.md) +- [Getting Started](./getting-started.md) - [Untyped Plutus Core](./uplc.md) - [Syntax](./uplc/syntax.md) - [Command-line utilities](./uplc/cli.md) diff --git a/book/src/getting-started.md b/book/src/getting-started.md new file mode 100644 index 00000000..cd0f8488 --- /dev/null +++ b/book/src/getting-started.md @@ -0,0 +1,22 @@ +# Getting Started + +## Installation + +### From Source + +```console +$ cargo install aiken +``` + +## QuickStart + +``` +$ aiken --help +``` + +## Editor Integrations + +| Editor | Plugin | +| --- | --- | +| VSCode | [TxPipe/vscode-aiken](https://github.com/txpipe/vscode-aiken/) | +| Vim/Neovim | [CardanoSolutions/aiken-vim](https://github.com/txpipe/aiken) |