diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000..a549d4b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,18 @@ +--- +name: bug +about: Create a bug report + +--- + +#### What Git revision are you using? + +#### What operating system are you using, and which version? + +- [ ] Linux / Ubuntu +- [ ] Linux / Other +- [ ] OSX +- [ ] Windows + +#### Describe what the problem is? + +#### What should be the expected behavior? diff --git a/.github/ISSUE_TEMPLATE/idea.md b/.github/ISSUE_TEMPLATE/idea.md new file mode 100644 index 00000000..bb1dc835 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/idea.md @@ -0,0 +1,11 @@ +--- +name: idea +about: Propose an idea or request a feature. + +--- + +### What is your idea? Provide a use case. + +### Why is it a good idea? + +### What is the current alternative and why is it not good enough? diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 006480db..c740dfa1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,13 @@ Open a [Bug Issue](https://github.com/txpipe/aiken/issues/new?template=bug.md). ### :bulb: How To Propose An Idea -Open a [Proposal Issue](https://github.com/txpipe/aiken/issues/new?template=idea.md). +Feel free to bring any idea as a [discussion [category: idea]](https://github.com/txpipe/aiken/discussions/new?category=ideas). Make sure to highlight your use case so we can understand the design space and agree on a solution. + +> **Note** Ideally, follow this simple template: +> +> - What is your idea? Describe it in simple words. Provide a use case. +> - Why is it a good idea? +> - What is the current alternative and why is it not good enough? ### :question: How To Ask a Question diff --git a/README.md b/README.md index d3dfdff8..1b226a96 100644 --- a/README.md +++ b/README.md @@ -3,35 +3,49 @@ Aiken

Cardano smart contract language and toolchain

- -[![Licence](https://img.shields.io/github/license/txpipe/aiken)](https://github.com/txpipe/aiken/blob/main/LICENSE) + +[![Licence](https://img.shields.io/github/license/txpipe/aiken)](https://github.com/txpipe/aiken/blob/main/LICENSE) [![Crates.io](https://img.shields.io/crates/v/aiken)](https://crates.io/crates/aiken) [![Rust Build](https://github.com/txpipe/aiken/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/txpipe/aiken/actions/workflows/rust.yml) [![mdBook Build](https://github.com/txpipe/aiken/actions/workflows/mdBook.yml/badge.svg?branch=main)](https://github.com/txpipe/aiken/actions/workflows/mdBook.yml) - +
-## Install +## QuickStart + +### Prerequisites For now you'll need rust installed, see [rustup](https://rustup.rs). -`cargo install aiken` +### Getting started -## Docs +```console +$ cargo install aiken -For more information please see the [docs](https://txpipe.github.io/aiken). +$ aiken --help +``` + +### How to use + +For more information please see the [user manual](https://txpipe.github.io/aiken). ## Roadmap -[see](https://txpipe.github.io/aiken/introduction.html#roadmap) +Aiken defines its roadmap [using _Github Milestones_](https://txpipe.github.io/aiken/introduction.html#roadmap). +The roadmap isn't set in stone, but gives a high-level overview of where the project is headed for. -## Art Credit +## Contributing + +Want to contribute? See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how. + +## Acknowledgment We'd like to give a special thanks to [@nkz](https://twitter.com/nkzthecreator) -for creating the logo and giving us the idea to name the project aiken. +for creating the logo and giving us the idea to name the project Aiken. -**Why the name Aiken?** +--- -The name comes from [Howard Aiken](https://en.wikipedia.org/wiki/Howard_H._Aiken), -an American physicist and a pioneer in computing. +> **Note** +> +> The name comes from [Howard Aiken](https://en.wikipedia.org/wiki/Howard_H._Aiken), an American physicist and a pioneer in computing.