tiny bug: it seems the key is obtained through "=key="
[org-ref.git] / README.org
index 5e25815..3f3489b 100644 (file)
@@ -1,79 +1,19 @@
+# -*- org-edit-src-content-indentation: 0; -*-
 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
 
+#+BEGIN_HTML
+<a href="https://travis-ci.org/jkitchin/org-ref"><img src="https://travis-ci.org/jkitchin/org-ref.svg?branch=master"></a>
+#+END_HTML
+
 See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch?v=JyvpSVl4_dg for examples of org-ref in action.
 
 [[./org-ref.org]] 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.
-
-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
@@ -92,3 +32,29 @@ You may want to set some convenient keys for working in your bibtex file:
 (global-set-key [f11] 'org-ref-open-bibtex-pdf)
 (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 [[https://github.com/jkitchin/org-ref/graphs/contributors][contributors]] to org-ref
+
+- https://github.com/divinenephron
+- https://github.com/OlafMerkert
+- https://github.com/prtkm
+
+And everyone who has filed an [[https://github.com/jkitchin/org-ref/issues][issue]], or asked about org-ref on the [[http://orgmode.org/community.html][org-mode Mailing list]].