Skip to content

Commit 3638ec3

Browse files
committed
Rearranged install sections on readme, updated confidence
1 parent 3336294 commit 3638ec3

File tree

1 file changed

+26
-30
lines changed

1 file changed

+26
-30
lines changed

README.md

+26-30
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,31 @@ If you're interested in improving this experience, [collaborate here](https://gi
8181

8282
## Install
8383

84+
### Cargo Install
85+
1. Install Cargo
86+
2. If you want run release version, type ```cargo install dura``` else type ```cargo install --git https://github.com/tkellogg/dura```
87+
88+
### By Source
89+
90+
1. Install Rust (e.g., `brew install rustup && brew install rust`)
91+
2. Clone this repository (e.g., `git clone https://github.com/tkellogg/dura.git`)
92+
3. Navigate to repository base directory (`cd dura`)
93+
4. Run `cargo install --path .` **Note:** If you receive a failure fetching the cargo dependencies try using the local [git client for cargo fetches](https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli). `CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --path .`
94+
95+
### Mac OS X
96+
97+
This installs `dura` and sets up a launchctl service to keep it running.
98+
99+
```bash
100+
$ brew install dura
101+
```
102+
103+
### Windows
104+
1. Download [rustup-init](https://www.rust-lang.org/tools/install)
105+
2. Clone this repository (e.g., `git clone https://github.com/tkellogg/dura.git`)
106+
3. Navigate to repository base directory (`cd dura`)
107+
4. Run `cargo install --path .` **Note:** If you receive a failure fetching the cargo dependencies try using the local [git client for cargo fetches](https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli). `CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --path .`
108+
84109
### Arch Linux
85110

86111
```bash
@@ -115,46 +140,17 @@ to develop:
115140
nix develop github:tkellogg/dura
116141
```
117142

118-
### Cargo Install
119-
1. Install Cargo
120-
2. If you want run release version, type ```cargo install dura``` else type ```cargo install --git https://github.com/tkellogg/dura```
121-
122-
### By Source
123-
124-
1. Install Rust (e.g., `brew install rustup && brew install rust`)
125-
2. Clone this repository (e.g., `git clone https://github.com/tkellogg/dura.git`)
126-
3. Navigate to repository base directory (`cd dura`)
127-
4. Run `cargo install --path .` **Note:** If you receive a failure fetching the cargo dependencies try using the local [git client for cargo fetches](https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli). `CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --path .`
128-
129-
### Windows
130-
1. Download [rustup-init](https://www.rust-lang.org/tools/install)
131-
2. Clone this repository (e.g., `git clone https://github.com/tkellogg/dura.git`)
132-
3. Navigate to repository base directory (`cd dura`)
133-
4. Run `cargo install --path .` **Note:** If you receive a failure fetching the cargo dependencies try using the local [git client for cargo fetches](https://doc.rust-lang.org/cargo/reference/config.html#netgit-fetch-with-cli). `CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --path .`
134-
135143
## FAQ
136144

137145
### Is this stable?
138146

139-
It's still in the prototype phase. Open issues pertaining to stability are marked with the
140-
[stability](https://github.com/tkellogg/dura/issues?q=is%3Aopen+is%3Aissue+label%3Astability) tag.
147+
Yes. Lots of people have been using it since 2022-01-01 without issue. It uses [libgit2](https://libgit2.org/) to make the commits, so it's fairly battle hardened.
141148

142149
### How often does this check for changes?
143150

144151
Every now and then, like 5 seconds or so. Internally there's a control loop that sleeps 5 seconds between iterations, so it
145152
runs less frequently than every 5 seconds (potentially a lot less frequently, if there's a lot of work to do).
146153

147-
### Does this work on my OS?
148-
149-
- Mac: yes
150-
- Linux: probably
151-
- Windows: yes
152-
153-
### Can I add sub commands and aliases?
154-
155-
Yes, any executable on the path named like `dura-{cmd}` will be executed
156-
when `dura {cmd}` is called. For example, `dura foo` will try to find an
157-
executable named `dura-foo` on the `$PATH`.
158154

159155
[build badge]: https://github.com/tkellogg/dura/actions/workflows/build.yaml/badge.svg
160156
[build action]: https://github.com/tkellogg/dura/actions/workflows/build.yaml

0 commit comments

Comments
 (0)