From 97edc164488352897eec1313b63d42aa06bb87a8 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Sat, 4 Jul 2020 22:33:59 +0200 Subject: Initial commit --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bf53d4 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ + + +# bibdirsync + +A command-line tool that synchronizes BibTeX bibliographies and local +directories. + +## Examples + +Download PDF files for the items in a bibliography file: +``` +$ bibdirsync fetch references.bib +``` + +Extract bibliography information from a PDF file and add it to a +bibliography file: +``` +$ bibdirsync import docs/interesting-article.pdf references.bib +``` + +Synchronize a bibliography file and a local directory by adding new items to +the bibliography file and downloading missing PDF files: +``` +$ bibdirsync sync docs references.bib +``` + +## Minimum Supported Rust Version + +This crate supports Rust 1.34.2 or later. + +## Contact + +For bug reports, patches, feature requests or other messages, please send a +mail to [bibdirsync-dev@ireas.org][]. + +## License + +This project is licensed under the [MIT License][]. + +`dialog-rs` complies with [version 3.0 of the REUSE specification][reuse]. + +[bibdirsync-dev@ireas.org]: mailto:bibdirsync-dev@ireas.org +[MIT license]: https://opensource.org/licenses/MIT +[reuse]: https://reuse.software/practices/3.0/ -- cgit v1.2.1