amble 0.1.4

First class, scalable rust project generator with batteries included.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# amble

[![Build Status]][actions]
[![License]][mit-license]
[![Docs]][Docs-rs]
[![Latest Version]][crates.io]
[![rustc 1.31+]][Rust 1.31]

[Build Status]: https://img.shields.io/github/actions/workflow/status/refcell/amble/ci.yml?branch=main
[actions]: https://github.com/refcell/amble/actions?query=branch%3Amain
[Latest Version]: https://img.shields.io/crates/v/amble.svg
[crates.io]: https://crates.io/crates/amble
[rustc 1.31+]: https://img.shields.io/badge/rustc_1.31+-lightgray.svg
[Rust 1.31]: https://blog.rust-lang.org/2018/12/06/Rust-1.31-and-rust-2018.html
[License]: https://img.shields.io/badge/license-MIT-7795AF.svg
[mit-license]: https://github.com/refcell/amble/blob/main/LICENSE.md
[Docs-rs]: https://docs.rs/amble/
[Docs]: https://img.shields.io/docsrs/amble.svg?color=319e8c&label=docs.rs


**First class, scalable rust project generator with batteries included.**

![](./etc/banner.png)

**[Install](./docs/install/installation.md)**
| [User Book](https://amble.refcell.org)
| [Developer Docs](./docs/developers/developers.md)
| [Crate Docs](https://crates.io/crates/amble)

_The project is still work in progress, see the [disclaimer below](#status)._

## What is amble?

`amble` is a fairly minimal cli application for generating rust projects
with batteries included and with an architecture that scales well, using a
workspace and sub-crates.

You can think of `amble` as an extension of `cargo new`.
Where `cargo new` ...


## Usage

Install `amble` using cargo.

```sh
cargo install amble
amble --version
```

Alternatively, `amble` can be built from source.

```sh
git clone git@github.com:refcell/amble.git
cd amble
cargo build --release
amble --version
```

## Status

`amble` is in https://github.com/refcell/amble/labels/alpha mode, and should be used for
experimentation only.

Local and devnet experimentation is highly encouraged.
New issues are also welcome.

In the meantime, contribute, experiment, and have fun!

## Troubleshooting & Bug Reports

Please check existing issues for similar bugs or
[open an issue](https://github.com/refcell/amble/issues/new)
if no relevant issue already exists.

## Contributions

All contributions are welcome!

## License

This project is licensed under the [MIT License](LICENSE.md).
Free and open-source, forever.

_All our rust are belong to you._