aselimov/pubs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor rewrite in readme.md

Browse Source
This commit is contained in:
Fabien Benureau 2015-12-03 16:55:10 +01:00
parent 4b3b2a23bd
commit da4723d6db
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
readme.md
View File

@ -10,12 +10,9 @@ Pubs is built with the following principles in mind:
- bibliographic data (i.e. pure bibtex information) is kept separated from metadata (including links to pdf or tags), - bibliographic data (i.e. pure bibtex information) is kept separated from metadata (including links to pdf or tags),
- everything is stored in plain text so it can be manually edited or version controlled. - everything is stored in plain text so it can be manually edited or version controlled.
Pubs is compatible with Python 2.7 and 3.3 and higher.
**Notice:** pubs is still in early development and cannot be considered as stable. **Notice:** pubs is still in early development and cannot be considered as stable.
Getting started Getting started
--------------- ---------------
Create your library (by default, goes to '~/.pubs/'). Create your library (by default, goes to '~/.pubs/').
@ -32,13 +29,11 @@ or for a .bib file containing a single reference:
pubs can also automatically retrieve the bibtex from a doi: pubs can also automatically retrieve the bibtex from a doi:
pubs add -D 10.1007/s00422-012-0514-6 pubs add -D 10.1007/s00422-012-0514-6 -d article.pdf
or an ISBN (dashes are ignored): or an ISBN (dashes are ignored):
pubs add -I 978-0822324669 pubs add -I 978-0822324669 -d article.pdf
The pdfs must still be downloaded manually.
References always up-to-date References always up-to-date
@ -51,7 +46,7 @@ If you use latex, you can automatize references, by creating a bash script with:
bibtex manuscript bibtex manuscript
latex manuscript.tex latex manuscript.tex
This ensure that your reference file is always up-to-date; you can cite a paper in your manuscript a soon as you add it in bibtex. This means that if you have, for instance, a doi on a webpage, you only need to do: This ensure that your reference file is always up-to-date; you can cite a paper in your manuscript a soon as you add it in pubs. This means that if you have, for instance, a doi on a webpage, you only need to do:
pubs add -D 10.1007/s00422-012-0514-6 pubs add -D 10.1007/s00422-012-0514-6
@ -59,10 +54,10 @@ and then add `\cite{Loeb_2012}` in your manuscript. After running the bash scrip
Requirements Requirements
------------ ------------
- python >= 2.7 - python >= 2.7 or >= 3.3
- [dateutil](http://labix.org/python-dateutil) - [dateutil](http://labix.org/python-dateutil)
- [pyYaml](http://pyyaml.org) (will be deprecated soon) - [pyYaml](http://pyyaml.org) (will be deprecated soon)
- [bibtexparser](https://github.com/sciunto/python-bibtexparser) >= 0.5.3 - [bibtexparser](https://github.com/sciunto/python-bibtexparser) >= 0.6.1
Authors Authors