Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leliel12 committed Jan 27, 2017
1 parent cb37c33 commit 5f7e8d2
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
scikit-criteria
===============

.. image:: ./doc/source/_static/logo_medium.png
:scale: 100 %

**Multiple-criteria decision analysis**

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

Install
-------

Expand All @@ -18,9 +21,17 @@ Test
$ python -m skcriteria.tests
Support
-------

- **Full Documentation and Tutorial:** scikit-criteria.org
- **Contact:** jbc.develop@gmail.com
- **Issues:** If you have issues please report them as a issue
here: https://github.com/leliel12/scikit-criteria/issues


Legal
-----
LOGO
----

- The scikit-criteria logo is a dereived work of
https://openclipart.org/detail/170778/retro-diamonds-abstract-009
Expand Down
52 changes: 52 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
===============
Scikit-Criteria
===============

.. only:: html

Expand All @@ -15,6 +18,55 @@ scikit-criteria is a collection of Multiple-criteria decision analysis (MCDA_)
methods integrated into scientific python stack. Is Open source and
commercially usable - `BSD license`_

Support
-------

You can contact me at jbc.develop@gmail.com

Code Repository & Issues: https://github.com/leliel12/scikit-criteria


License
-------

Scikit-Criteria is under
`The 3-Clause BSD License <https://raw.githubusercontent.com/leliel12/scikit-criteria/master/LICENCE.txt>`__

This license allows unlimited redistribution for any purpose as long as its
copyright notices and the license's disclaimers of warranty are maintained.


Citation
--------

If you are using Scikit-Criteria in your research, please cite:

If you use scikit-learn in a scientific publication, we would appreciate
citations to the following paper:

`Scikit-learn: Machine Learning in Python
<http://45jaiio.sadio.org.ar/sites/default/files/Sio-23.pdf>`_, Cabral
*et al.*, SIO 12, pp. 2825-2830, 2011.

Scikit-Criteria: Colección de métodos de
análisis multi-criterio integrado al stack
científico de Python


Bibtex entry::

@article{scikit-learn,
title={Scikit-learn: Machine Learning in {P}ython},
author={Pedregosa, F. and Varoquaux, G. and Gramfort, A. and Michel, V.
and Thirion, B. and Grisel, O. and Blondel, M. and Prettenhofer, P.
and Weiss, R. and Dubourg, V. and Vanderplas, J. and Passos, A. and
Cournapeau, D. and Brucher, M. and Perrot, M. and Duchesnay, E.},
journal={Journal of Machine Learning Research},
volume={12},
pages={2825--2830},
year={2011}
}



Contents:
Expand Down

0 comments on commit 5f7e8d2

Please sign in to comment.