diff options
| author | Toby Vincent <tobyv13@gmail.com> | 2023-05-20 14:57:27 -0500 |
|---|---|---|
| committer | Toby Vincent <tobyv13@gmail.com> | 2023-05-20 15:04:29 -0500 |
| commit | 00d1d128396560d4eca7c9ae8f6e4c016e05665e (patch) | |
| tree | a494749c489e2222c577e0ba4cacff6ae54e9a24 /README.md | |
| parent | 5c9d395e6efb0a032b4178949d1e1821fd61f2f0 (diff) | |
docs: fix links and improve layout
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 64 |
1 files changed, 42 insertions, 22 deletions
@@ -1,7 +1,9 @@ # Projectr -`projectr` is directory search tool that produces a MRU sorted list of project -directory paths using provided contexts and filters. +A contextual, MRU sorted, project finder. + +`projectr` is project discovery tool that produces a MRU sorted list of project +directories using provided contexts and filters. ## Installation @@ -11,11 +13,10 @@ directory paths using provided contexts and filters. cargo install --git=https://git.sr.ht/~tobyvin/projectr ``` -### Building - -Provided you have [Rust installed], projectr can be built using Cargo. +### Building from source -[Rust installed]: https://www.rust-lang.org/tools/install +Provided you have [Rust installed](https://www.rust-lang.org/tools/install), +projectr can be built using Cargo. ```sh $ git clone https://git.sr.ht/~tobyvin/projectr @@ -25,28 +26,47 @@ $ ./target/release/projectr --version projectr 0.2.1 ``` -### Contributing +## Usage + +To list all available options run `projectr -h`. + +For a working example, see [tmux-projectr]. + +## Releases + +A list of changes in each release can be found in [CHANGELOG.md]. + +Subscribe to release announcements on [~tobyvin/projectr-announce@lists.sr.ht]. + +## Troubleshooting -Anyone can contribute to projectr. Please refer to -[CONTRIBUTING.md](https://git.sr.ht/~tobyvin/projectr/tree/master/item/CONTRIBUTING.md). +Ask for support or follow general discussions in +[~tobyvin/projectr-discuss@lists.sr.ht]. -## Resources +For bug reports and feature requests see [Submitting bug reports and feature +requests] section in [CONTRIBUTING.md]. -Ask for support or follow general discussions on -[~tobyvin/projectr-discuss@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-discuss). +## Maintainer -Send patches and development related questions to -[~tobyvin/projectr-devel@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-devel). +[Toby Vincent <tobyv@tobyvin.dev>](tobyvin.dev) -Instructions for preparing a patch are available at -[git-send-email.io](https://git-send-email.io) +## Contribution -Subscribe to release announcements on -[~tobyvin/projectr-announce@lists.sr.ht](https://lists.sr.ht/~tobyvin/projectr-announce) +Anyone is welcome to contribute to projectr. Please refer to [CONTRIBUTING.md]. -Submit _confirmed_ bug reports and _confirmed_ feature requests on -[https://todo.sr.ht/~tobyvin/projectr](https://todo.sr.ht/~tobyvin/projectr). +## License -[License](https://git.sr.ht/~tobyvin/projectr/tree/master/item/LICENSE). +projectr is licensed under the [MIT]. -[Change log](https://git.sr.ht/~tobyvin/projectr/tree/master/item/CHANGELOG.md). +[~tobyvin/projectr-announce@lists.sr.ht]: + https://lists.sr.ht/~tobyvin/projectr-announce +[~tobyvin/projectr-discuss@lists.sr.ht]: + https://lists.sr.ht/~tobyvin/projectr-discuss +[tmux-projectr]: + https://git.sr.ht/~tobyvin/projectr/tree/main/item/bin/tmux-projectr +[MIT]: https://git.sr.ht/~tobyvin/projectr/tree/main/item/LICENSE +[CHANGELOG.md]: https://git.sr.ht/~tobyvin/projectr/tree/main/item/CHANGELOG.md +[CONTRIBUTING.md]: + https://git.sr.ht/~tobyvin/projectr/tree/main/item/CONTRIBUTING.md +[Submitting bug reports and feature requests]: + https://git.sr.ht/~tobyvin/projectr/tree/main/item/CONTRIBUTING.md#submitting-bug-reports-and-feature-requests |