From 80e66dc075eab012711cfe2e464ef749871d3ec9 Mon Sep 17 00:00:00 2001 From: Chengcheng-Xiao Date: Wed, 30 Jun 2021 13:46:06 +0100 Subject: [PATCH] Add citation section to README.md. --- README.md | 4 +++- vasp2wan90.bib | 5 +++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 vasp2wan90.bib diff --git a/README.md b/README.md index 1e2bb97..f01bc06 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,11 @@ A list of useful keywords: | LWRITE_UNK | Do we want the `UNK` files? | TRUE/FALSE | FALSE | | LUNK_FMTED | Do we want the `UNK` files be human-readable? | TRUE/FALSE | FALSE | | LREDUCE_UNK | Do we want the `UNK` files be reduced in size? | TRUE/FALSE | FALSE | -| LWRITE_SPN | Do we want the `.spn` files? (__Serial only__) | TRUE/FALSE | FALSE | +| LWRITE_SPN | Do we want the `.spn` files? (__Serial only__) | TRUE/FALSE | FALSE | | LSPN_FMTED | Do we want the `.spn` files be human-readable? | TRUE/FALSE | FALSE | +## How to cite +Citation of the code is not mandatory but would be appreciated. A reference to this website using this [BibTeX entry](./vasp2wan90.bib) will suffice. ## Contributing Issues and pull-requests are welcome, feel free to ask anything [E-mail](iconxicon@me.com). diff --git a/vasp2wan90.bib b/vasp2wan90.bib new file mode 100644 index 0000000..dabd7ba --- /dev/null +++ b/vasp2wan90.bib @@ -0,0 +1,5 @@ +@Misc{VASP2WAN90_v2_fix, + author = {Chengcheng Xiao}, + title = {The VASP2WAN90_v2_fix patch}, + howpublished = {\url{https://github.com/Chengcheng-Xiao/VASP2WAN90_v2_fix/}} +}