diff options
| -rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d69e55 --- /dev/null +++ b/README.md @@ -0,0 +1,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). |