From: John Kitchin <jkitchin@andrew.cmu.edu>
Date: Thu, 18 Dec 2014 14:59:02 +0000 (-0500)
Subject: created a readme
X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=commitdiff_plain;h=7b6eedc9d1d351bb4913c907ad0dcd4209e7537b;ds=sidebyside

created a readme
---

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..024bab8
--- /dev/null
+++ b/README.org
@@ -0,0 +1,17 @@
+#+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
+
+You should read [[./org-ref.org]]. It contains all documentation and installation instructions.
+
+[[./doi-utils.org]] contains functions for downloading bibtex entries from  a DOI, and redefines the org-mode doi link so it has more functionality.
+
+[[./jmax-bibtex.el]] contains some utility functions:
+
+1. jmax-bibtex runs a menu command with actions to run on a bibtex entry including looking up the doi for the entry in a variety of places, e.g. web of science related/citing articles, Google Scholar, Pubmed, and crossref, or opening a PDF associated with the entry.
+
+2. Bind M-n/M-p to next/previous bibtex entry.
+
+3. Sentence/title casing the title of a bibtex entry
+
+4. Function to replace non-ascii characters in bibtex entries
+
+5. Functions to replace journal names with @string entries, and corresponding short/long names.