Skip to content

Commit 2d4d883

Browse files
docs: Update README.md
1 parent 50f9ac7 commit 2d4d883

1 file changed

Lines changed: 34 additions & 3 deletions

File tree

README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# hello-rust
22

3-
[![Crates.io](https://img.shields.io/crates/v/hello-rust.svg)](https://crates.io/crates/hello-rust)
4-
[![Docs.rs](https://docs.rs/hello-rust/badge.svg)](https://docs.rs/hello-rust)
53
[![CI](https://github.com/pythoninthegrass/hello-rust/workflows/CI/badge.svg)](https://github.com/pythoninthegrass/hello-rust/actions)
64

75
## Setup
@@ -10,8 +8,41 @@
108

119
* Install the rust toolchain in order to have cargo installed by following
1210
[this](https://www.rust-lang.org/tools/install) guide.
13-
* run `cargo install hello-rust`
11+
* Install `hello-rust` via
12+
```bash
13+
# remote
14+
cargo install --git https://github.com/pythoninthegrass/hello-rust
1415

16+
# local
17+
cargo install --path .
18+
```
19+
20+
## Development
21+
22+
### Setup
23+
24+
* Follow the [setup instructions](#setup) above to set up your environment
25+
* Install [devbox](https://www.jetpack.io/devbox/docs/quickstart/)
26+
```bash
27+
curl -fsSL https://get.jetpack.io/devbox | bash
28+
```
29+
30+
### Usage
31+
32+
* Basic commands
33+
```bash
34+
# install dependencies
35+
devbox install
36+
37+
# enter devbox
38+
devbox shell
39+
40+
# refresh devbox after making changes to devbox.json
41+
refresh
42+
43+
# deactivate devbox
44+
exit
45+
```
1546

1647
## Further reading
1748

0 commit comments

Comments
 (0)