Giter VIP home page Giter VIP logo

papiers's Introduction

Papiers

Papiers is a tool to index your pdf files/research papers/โ€ฆ and quickly search through them.

Build instructions

  • Install the dependencies (opam install batteries yojson ANSITerminal uri camlzip cmdliner cpdf lambda-term if you have opam)
  • Edit the src/config.ml if you want to change the default reader for the sources (default: xdg-open), or the colors.
  • Then:
./configure  
make && sudo make install

You can build the html documentation for the papierslib library by running:

make doc

After that the generated documentation will be in the papierslib_api.docdir directory.

How to use Papiers

Papiers now works a bit like git: you have papiers repositories; a repository is located in a directory, and index sources that are contained in this directory.

  • Initialize a new repository in the current directory: papiers init
  • Add documents to the database: papiers doc add interesting_paper.pdf
  • Make queries to the database: papiers search keyword1 keyword2
  • Type papiers --help to see the other possibilities

A query is more or less simply a list of keywords, that are searched through the documents informations, like the title, authors, sources and tags.

You may want to refine this keyword based search. It is possible in some way by using prefixes:

  • If you prepend a keyword with tag: or ta:, it will only match tags.
  • Prepend with title: or ti:, it'll search only in titles.
  • With a:, au: or author:, only in authors.
  • With s:, src: or source:, only in sources.
  • With la: or lang:, only for languages.

papiers's People

Contributors

armael avatar gasche avatar misg avatar acieroid avatar c-cube avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.