added some export functions to get a pdf and html version of the doc.
[org-ref.git] / README.org
index b31adde..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
@@ -22,62 +23,10 @@ See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch
 
 5. Functions to replace journal names with @string entries, and corresponding short/long names.
 
-To install this, add the org-ref repo directory to your load-path, and
-
-#+BEGIN_SRC emacs-lisp
-(add-to-list 'load-path "path-to-org-ref")
-(require 'jmax-bibtex)
-#+END_SRC
-
 * Installation
-You should clone this repository somewhere.
-
-Here is how I load org-ref. This code is in my init.el file.
-
-#+BEGIN_SRC emacs-lisp
-;; remember this directory
-(defconst starter-kit-dir (file-name-directory (or load-file-name (buffer-file-name)))
-    "Directory where the starterkit is installed.")
-
-;;;;;;; org path for loadable org-files
-(defvar org-load-path
-  (list (file-name-as-directory
-        (expand-file-name "org" starter-kit-dir)))
-  "List of directories to find org-files that `org-babel-load-file' can load code from.")
-
-(defun org-require (feature)
-  "Load a FEATURE from an org-file.
-FEATURE is a symbol, and it is loaded from an org-file by the name of FEATURE.org, that is in the `org-load-path'.  The FEATURE is loaded from `org-babel-load-file'."
-  (let ((org-file (concat (symbol-name feature) ".org"))
-       (path))
-
-    ;; find the org-file
-    (catch 'result
-      (loop for dir in org-load-path do
-           (when (file-exists-p
-                  (setq path
-                        (expand-file-name
-                         org-file
-                         dir)))
-             (throw 'result path))))
-    (let ((default-directory (file-name-directory path)))
-      (org-babel-load-file path))))
-
-;; https://github.com/jkitchin/org-ref
-;; for loading org-files
-(add-to-list 'org-load-path
-            (expand-file-name "org-ref" starter-kit-dir))
-
-;; for loading emacs-lisp files
-(add-to-list 'load-path
-            (expand-file-name "org-ref" starter-kit-dir))
-
-(org-require 'org-ref)
-(org-require 'doi-utils)
-(org-require 'pubmed)
-(require 'jmax-bibtex)
-#+END_SRC
+We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref.
 
+You should clone this repository somewhere.
 
 You should set these variables. Here is an example of how mine are set in an init.el file.
 #+BEGIN_SRC emacs-lisp
@@ -97,8 +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
 
+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