From bcb406fe3f8817f7f199e471d26bc222e42270bb Mon Sep 17 00:00:00 2001 From: Ken Kellner Date: Thu, 3 May 2018 16:22:02 -0400 Subject: Add installation info to README --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00d944e..921f9f4 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,12 @@ Currently, the following publishers are supported: * BioOne * Royal Society * PLoS ONE -* National Institutes of Health (NIH) +* National Institutes of Health * NRC Research Press * Taylor & Francis +* Annual Reviews +* Nature Publishing +* University of Chicago Press Dependencies ------------ @@ -34,12 +37,29 @@ Dependencies * [Geckodriver](https://github.com/mozilla/geckodriver/releases) installed somewhere in `$PATH` * [Pandoc](http://pandoc.org/) -Python packages (available with `pip`): + Python packages (available with `pip`): * [Selenium](http://selenium-python.readthedocs.io/) * [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/) * [pypandoc](https://github.com/bebraw/pypandoc) +Installation +------------ + +I plan to properly package the application for installation with `pip` in the future, but for now it has to be installed manually. + +1. Make sure the dependencies listed above are installed. + +2. Clone the repository: + + ```sh + git clone https://github.com/kenkellner/article-epub + ``` + +3. Make `article-epub.py` executable and put it in your `$PATH`. + +4. To allow importing the library for use in other Python scripts, copy (or symlink) the `article_epub` folder into your local Python 3 library (e.g. `~/.local/lib/python3.6/site-packages/`). + Usage ----- -- cgit v1.2.3