Slightly rework README + add issues templates.
This commit is contained in:
parent
aae6e2f360
commit
c1a9eff5d0
|
@ -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?
|
|
@ -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?
|
|
@ -77,7 +77,13 @@ Open a [Bug Issue](https://github.com/txpipe/aiken/issues/new?template=bug.md).
|
||||||
|
|
||||||
### :bulb: How To Propose An Idea
|
### :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
|
### :question: How To Ask a Question
|
||||||
|
|
||||||
|
|
40
README.md
40
README.md
|
@ -3,35 +3,49 @@
|
||||||
<img src="https://raw.githubusercontent.com/txpipe/aiken/main/assets/logo-dark.png?sanitize=true#gh-light-mode-only" alt="Aiken" max-height="240" />
|
<img src="https://raw.githubusercontent.com/txpipe/aiken/main/assets/logo-dark.png?sanitize=true#gh-light-mode-only" alt="Aiken" max-height="240" />
|
||||||
<hr />
|
<hr />
|
||||||
<h2 align="center" style="border-bottom: none">Cardano smart contract language and toolchain</h2>
|
<h2 align="center" style="border-bottom: none">Cardano smart contract language and toolchain</h2>
|
||||||
|
|
||||||
[](https://github.com/txpipe/aiken/blob/main/LICENSE)
|
[](https://github.com/txpipe/aiken/blob/main/LICENSE)
|
||||||
[](https://crates.io/crates/aiken)
|
[](https://crates.io/crates/aiken)
|
||||||
[](https://github.com/txpipe/aiken/actions/workflows/rust.yml)
|
[](https://github.com/txpipe/aiken/actions/workflows/rust.yml)
|
||||||
[](https://github.com/txpipe/aiken/actions/workflows/mdBook.yml)
|
[](https://github.com/txpipe/aiken/actions/workflows/mdBook.yml)
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Install
|
## QuickStart
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
For now you'll need rust installed, see [rustup](https://rustup.rs).
|
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
|
## 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)
|
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),
|
> **Note**
|
||||||
an American physicist and a pioneer in computing.
|
>
|
||||||
|
> The name comes from [Howard Aiken](https://en.wikipedia.org/wiki/Howard_H._Aiken), an American physicist and a pioneer in computing.
|
||||||
|
|
Loading…
Reference in New Issue