From caa8e17538b66bdc4291a1fc50a3bbe25a13f86a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milo=C5=A1=20Jovanovi=C4=87?= Date: Sun, 24 Mar 2019 20:01:30 +0100 Subject: [PATCH] fixed README and renamed template --- README.md | 23 +++++++++++++---------- reference.docx => template.docx | Bin 2 files changed, 13 insertions(+), 10 deletions(-) rename reference.docx => template.docx (100%) diff --git a/README.md b/README.md index 5b80397..6b89849 100644 --- a/README.md +++ b/README.md @@ -3,27 +3,30 @@ This is a bash script which helps convert markdown files into properly formatted Word files for academics. It is a work in progress. ## Workflow -The script lets you write your document in Markdown, and then convert it to a valid .docx using almost any citation style. +The script needs three things: +*1) Citation styles* You will need to download [citation-styles](https://github.com/citation-style-language/styles), and specify the one you want to use in the command line switches. +*2) A Reference Library* For the converter to know what works you are citing, you will need a .bib library file with the citations. I recommend using Zotero and [BetterBiBTeX](https://retorque.re/zotero-better-bibtex/) to keep track of your books and articles and what not. The extension should autoupdating your citations with unique keys that way. -Finally, you will need a reference file, so markdownacademic will know what your document should look like - what the margins and fonts are, etc. You can often download a reference .docx file from the journal you're writing for. A sample file `reference.docx` is included. +*3) A Template file* +Finally, you will need a template file, so markdownacademic will know what your document should look like - what the margins and fonts are, etc. You can often download a template .docx file from the website of the journal you're writing for. A sample `template.docx` is included. -* TODO Why should I do this? - * Uses little memory, write comfortably on a computer from 1984 - * Don't need Word to write a proper file that can be submitted to a journal - * Document is a regular text file, will never suffer planned obsolescence +## Why should I do this? + * Uses little memory, you can write text files comfortably on a computer from 1984 + * Don't need Word to write a proper .docx that can be submitted to a journal + * Original document is a regular text file, will never suffer planned obsolescence * Track your changes and collaborate using Git * Quickly change the formatting of your output document * Quickly change citation style into any style you want -* TODO Vim tips and tricks +*TODO* Explain this section better +*TODO* Vim tips and tricks ## Installation -Put the script in your executable directory (`~/.local/share/bin` on most Linux distributions. - +Put the script in your executable directory or run it from wherever you clone this repository. ### Dependencies ``` @@ -33,7 +36,7 @@ pandoc ## Usage -You can print usage by running ``markdownacademic --usage`` +You can print usage by running ``markdownacademic -h`` ``` Usage: markdownacademic -bctih diff --git a/reference.docx b/template.docx similarity index 100% rename from reference.docx rename to template.docx