added some export functions to get a pdf and html version of the doc.
[org-ref.git] / README.org
index b0ae914..b2622eb 100644 (file)
@@ -1,3 +1,4 @@
+# -*- org-edit-src-content-indentation: 0; -*-
 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
 
 #+BEGIN_HTML
@@ -45,24 +46,25 @@ You may want to set some convenient keys for working in your bibtex file:
 (global-set-key [f12] 'org-ref-open-in-browser)
 #+END_SRC
 
-Change into the directory you cloned org-ref into and run this command to generate the elisp files.
-#+BEGIN_SRC sh
-make tangled
-#+END_SRC
-
 Add the directory you cloned org-ref into to your load-path, and require the features you want.
 #+BEGIN_SRC emacs-lisp
 (add-to-list 'load-path "path-to-org-ref")
+;; make sure you have dash, helm, helm-bibtex, ebib, s, f, hydra and key-chord
+;; in your load-path
 (require 'org-ref)
+
+;; optional but very useful libraries in org-ref
 (require 'doi-utils)
 (require 'jmax-bibtex)
 (require 'pubmed)
 (require 'arxiv)
+(require 'sci-id)
 #+END_SRC
 
+Please report errors here:  [[https://github.com/jkitchin/org-ref/issues][issue]]s.
 
 * Contributors
-I would like to thank the following contributors to org-ref
+I would like to thank the following [[https://github.com/jkitchin/org-ref/graphs/contributors][contributors]] to org-ref
 
 - https://github.com/divinenephron
 - https://github.com/OlafMerkert