diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bf53d4 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +<!--- +SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org> +SPDX-License-Identifier: MIT +--> + +# 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/ |