Add citation section to README.md.

Chengcheng-Xiao · Jun 30, 2021 · 80e66dc · 80e66dc
1 parent 720fe5c
commit 80e66dc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git 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]([email protected]).
diff --git a/vasp2wan90.bib 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/}}
+}