README.md

   1 # PropRef. Propositions' references #
   2
   3 The aim of this project is to provide a search engine for (mathematical) axioms, definitions, theorems, lemmas, corollaries, etc. Not mere search engine of documents containing this elements, but a search engine of the results and axioms of Axiomatic Theories. An example: I want to know a new area of mathematics: triangular conorms.
   4
   5   *  What are the main theorems of this area?
   6   *  What are the definitions I have to learn?
   7   *  What are the open problems?
   8   *  Can I get the demostrations of the main results?
   9   *  What sources I have to read first to understand this area?
  10   *  What are the most cited articles?
  11   *  Are there a books of this area?
  12   *  In what Axiomatic Theory does it belong to?
  13   *  What are the main authors in this area?
  14   *  And what are the journals of reference?
  15
  16 `PropRef` is created for *trying* to solving these problems.
  17
  18 ## Source code ##
  19
  20   * You can obtain the source code running:
  21     * `git clone https://github.com/quatrilio/propref.git` or
  22     * `git clone http://repo.or.cz/w/propref.git`
  23   * If you want to obtain the source code of the wiki, you can run:
  24     * `git clone https://github.com/quatrilio/propref.wiki.git` or
  25     * `git clone http://repo.or.cz/w/propref-wiki.git`
  26
  27 ## Installation ##
  28
  29 ### Dependencies ###
  30
  31   * Install `git` on your system
  32   * [Set properly]((http://golang.org/doc/code.html#GOPATH)) `GOPATH` and `GOROOT`
  33
  34 ### Installation ###
  35
  36 You have to run
  37
  38 ```
  39 go get github.com/quatrilio/propref
  40 ```
  41
  42 and it will install the binary `propref` into `$GOPATH/bin`.
  43
  44 If you want to update the package, just run
  45
  46 ```
  47 go get -u github.com/quatrilio/propref
  48 ```
  49
  50 ## Usage ##
  51
  52 `propref` or `propref --help` prints help about usage of the program:
  53
  54 ```
  55 Usage of propref:
  56   -path="": Path of the file. Example /home/user/foo.tex
  57   -syntax="auto": Syntax of the file: latex, context, ... If 'auto' the syntax is determining with the type of the file (according to file command)
  58 ```
  59
  60 I think it's self-explaning thing.
  61
  62 ## Documentation ##
  63
  64 You can see all the documentation in the [wiki](https://github.com/quatrilio/propref/wiki) (or [here](http://repo.or.cz/w/propref-wiki.git)).
  65
  66 ## License ##
  67
  68 This repository contains three parts:
  69
  70   * The software which basically extracts information of several files. This information is mainly formed by propositions, definitions, axioms and any other textual information such as language, authors of paper, etc.
  71   * The database of this extracted information
  72   * And the documentation of the software, contents of the web page or any other things related.
  73
  74 The software is distributed under de the [Affero General Public License 3.0](http://www.gnu.org/licenses/agpl-3.0.html) or above, the database is distributed under the [Open Database License 1.0](http://opendatacommons.org/licenses/odbl/) or above and the documentation is released under the [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) or above.
  75
  76 All the contents of the repository are property of the respective owners: Xavier <quatrilio@gmail.com> and other contributions. All the contribution can be seen in the history of the repository.
  77
  78 ## Participation ##
  79
  80 The participation of this project is open. If you want to contribute to code, documentate or anything else, contact me. I will be very glad to see participation. If your contribution is worthy, I will integrate to this project. If you don't like my criteria, you could fork this project. No problem.
  81