aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4bf53d47ede9bbf5460a58648c95193ca2115bc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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/