Go to file
Matthias Benkort 53eab4b3fd
Merge pull request #185 from aiken-lang/aiken-docs
Aiken docs
2022-12-17 13:14:11 +01:00
.github chore: retire mdbook 2022-12-15 14:17:36 -05:00
assets chore: add more assets 2022-09-06 20:14:27 -04:00
crates Improve rendering of type-signatures in docs 2022-12-17 13:07:28 +01:00
examples fix: properly capture empty lines 2022-12-15 11:12:35 -05:00
.editorconfig rename examples/tests/{a,b,c,d,e,f} into examples/acceptance_tests/00{1,2,3,4,5,6} 2022-12-14 09:45:24 +01:00
.gitignore feat: start when expressions 2022-12-05 14:18:44 -05:00
CHANGELOG.md fix: correct V1 to_plutus_data() for txout with no datum hash 2022-12-15 18:22:31 -05:00
CONTRIBUTING.md update contribution docs 2022-12-08 14:27:19 -05:00
Cargo.lock Introduce 'docs' for generating documentation for aiken libraries. 2022-12-16 18:33:04 +01:00
Cargo.toml fix: include return type in one function def 2022-10-04 16:32:32 -04:00
LICENSE Create LICENSE 2022-06-14 18:47:40 -04:00
README.md fix: this badge no longer exists 2022-12-15 18:26:28 -05:00
bonnie.toml chore: retire mdbook 2022-12-15 14:17:36 -05:00

README.md

Aiken Aiken

Cardano smart contract language and toolchain

Licence Crates.io Rust Build


QuickStart

Prerequisites

For now you'll need rust installed, see rustup.

Getting started

In case you have fresh installation of rustup you might need to do:


rustup install stable

$ cargo install aiken

$ aiken --help

How to use

For more information please see the user manual.

Roadmap

Aiken defines its roadmap using Github Milestones. The roadmap isn't set in stone, but gives a high-level overview of where the project is headed for.

Contributing

Want to contribute? See CONTRIBUTING.md to know how.

Acknowledgment

We'd like to give a special thanks to @nkz for creating the logo and giving us the idea to name the project Aiken.


Note

The name comes from Howard Aiken, an American physicist and a pioneer in computing.