X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=README.org;h=3f3489b3b37eb9a7690834325c94830ed22f0cfc;hp=2c1bcc2cebd24b430b95951a0de11fae4ba5b961;hb=f441536510bee202f0c7ce373cc0d60b88a267fd;hpb=b5c392e044e6828541e35fa2a4ba96d799290730 diff --git a/README.org b/README.org index 2c1bcc2..3f3489b 100644 --- a/README.org +++ b/README.org @@ -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 @@ -8,19 +9,6 @@ See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch [[./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. * Installation We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref. @@ -43,11 +31,6 @@ You may want to set some convenient keys for working in your bibtex file: (global-set-key [f10] 'org-ref-open-bibtex-notes) (global-set-key [f11] 'org-ref-open-bibtex-pdf) (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. @@ -56,12 +39,16 @@ Add the directory you cloned org-ref into to your load-path, and require the fea ;; 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 +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