summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 1d69e551115b11e26a6439a20cb46d6092eb0e2a (plain)
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
# Projectr

`projectr` is directory search tool that produces a MRU sorted list of project
directory paths using provided contexts and filters.

## Installation

### Using Cargo

```sh
cargo install --git=https://git.sr.ht/~tobyvin/projectr
```

### Building

Provided you have [Rust installed], projectr can be built using Cargo.

[Rust installed]: https://www.rust-lang.org/tools/install

```sh
$ git clone https://git.sr.ht/~tobyvin/projectr
$ cd projectr
$ cargo build --release
$ ./target/release/projectr --version
projectr 0.2.1
```

### Contributing

Anyone can contribute to projecr. Please refer to
[CONTRIBUTING.md](https://git.sr.ht/~tobyvin/projectr/tree/master/item/CONTRIBUTING.md).

## Resources

Ask for support or follow general discussions on
[~tobyvin/projectr-discuss@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-discuss).

Send patches and development related questions to
[~tobyvin/projectr-devel@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-devel).

Instructions for preparing a patch are available at
[git-send-email.io](https://git-send-email.io)

Subscribe to release announcements on
[~tobyvin/projectr-announce@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-announce)

Submit _confirmed_ bug reports and _confirmed_ feature requests on
[https://todo.sr.ht/~tobyvin/projectr](https://todo.sr.ht/~rjarry/aerc).

[License](https://git.sr.ht/~tobyvin/projectr/tree/master/item/LICENSE).

[Change log](https://git.sr.ht/~tobyvin/projectr/tree/master/item/CHANGELOG.md).