doru
| Crates.io | doru |
| lib.rs | doru |
| version | |
| source | src |
| created_at | 2024-12-06 18:07:03.611304 |
| updated_at | 2024-12-06 18:07:03.611304 |
| description | A simple library providing basic Todo functionality. |
| homepage | |
| repository | https://github.com/matej-almasi/doru |
| max_upload_size | |
| id | 1474499 |
| Cargo.toml error: | TOML parse error at line 17, column 1 | 17 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
(matej-almasi)
documentation
README
Doru
Doru is a simple TODO list in your terminal.
Features
Add new TODOs
doru add "Code something amazing"
List all your TODOs
doru list
[ ] Learn Rust [Open] (ID: 1)
[ ] Build a project [InProgress] (ID: 2)
[ ] Publish on GitHub [Open] (ID: 3)
Edit a TODO
doru edit 1 "Learn Rust like a Pro"
Update status of a TODO
doru status 1 in-progress
List TODOs with specific status
doru list in-progress
[ ] Learn Rust like a Pro [InProgress] (ID: 1)
[ ] Build a project [InProgress] (ID: 2)
Delete a TODO
doru delete 3
Installation
Using Cargo Install
You can use Cargo to install Doru from crates.io
Download the binary directly
TODO: add instructions to download artifact from GitHub, when ready
If you want to run Doru like in the examples above, you will need to add Doru to your Path.
Build from source
If you have Rust toolchain installed on your machine, you can clone directly from GitHub and build locally. No additional dependencies are required:
git clone https://github.com/yourusername/doru.git
cd doru
cargo build --release
Configuration
Doru stores TODO items in a JSON file. By default, this file is located at
~/.doru/TODOs.json. You can change the location of the storage file by
setting the DORU_PATH environment variable or by using the --path
option with the doru command.
Documentation
TODO: add docs.rs link
If you cloned the repository, you can run
cargo doc --no-deps --open
to generate the documentation and open it in your browser.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.