Skip to content

Commit

Permalink
readme + cargo: prepare for crates.io release
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelohdez committed Feb 24, 2024
1 parent b2ed025 commit 7f2dfca
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ keywords = ["wayland", "smithay"]
version = "0.1.0"
edition = "2021"

[[bin]]
name = "dim"
path = "src/main.rs"

[dependencies]
anyhow = "1.0.79"
clap = { version = "4.5.1", features = ["derive"] }
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,16 @@ dim --help

## Installing

### Building Manually
Ensure you have [Rust] installed.

dim is available on crates.io as `dim-screen` to avoid naming conflicts but
the binary is still `dim`:

```bash
cargo install dim-screen
```

_Currently the only way to install_, ensure you have [Rust] installed.
### Building Manually

Choose a directory for this repo, then clone and `cd` into it:

Expand All @@ -39,7 +46,8 @@ git clone https://github.com/marcelohdez/dim
cd dim
```

Lastly, `cargo` can install `dim` for you, placing the binary in `$HOME/.cargo/bin/`:
Lastly, `cargo` can build and install `dim` for you, placing the binary in
`$HOME/.cargo/bin/`:

```bash
cargo install --path .
Expand All @@ -51,7 +59,7 @@ Or, if you would like to place the binary in your `$PATH` yourself:
cargo build -r
```

And the resulting binary should be in `./targer/release/dim`.
And the resulting binary should be in `./target/release/dim`.

## License

Expand Down

0 comments on commit 7f2dfca

Please sign in to comment.