info files updated

dokato · Aug 29, 2015 · 26ecbb8 · 26ecbb8
1 parent 90acbc9
commit 26ecbb8
Show file tree

Hide file tree

Showing 3 changed files with 121 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,37 @@
+Changelog
+===============
+
+#### 0.36
+* bug fixing
+* data loading improved
+* better plotting
+* some additional files: license, readme and so on added
+
+#### 0.34
+* short-time statistics
+* documentation in sphinx ready on readthedocs
+* visualization improved
+* conversion to trans3d
+* more examples
+
+#### 0.31
+* connectivity methods: gDTF, gPDC, Coherency, PSI, GCI
+* new mvar estimation criterion: FPE
+* statistics for multitrial (bootstrap) and normal case (surrogate data)
+* fitting mvar for multitrial
+* short-time versions of estimation
+* data plotting
+* working example
+
+#### 0.2
+* connectivity methods: DTF, PDC, Partial Coherence, iPDC
+* mvar estimation criterions
+* mvar class static
+
+#### 0.1
+* data class with simple preprocessing methods
+* mvar class almost done
+
+#### 0.05
+* project structure
+* basic fitting
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,79 @@
+Contributing to ConnectiviPy
+======================
+
+Welcome! Contributions to project are greatly appreciated! Everyone can
+help, but before work read some simple rules listed below.
+
+Types of contributions
+---------------------
+
+## Bugs reports
+
+To report a bug visit https://github.com/dokato/connectivipy/issues and
+create new issue. Each issue should inlcude:
+
+* Your operating system name and version.
+* Version of `connectivipy`.
+
+    >> import connectivipy
+    >> connectivipy.__version__
+    
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+## Features suggestion 
+
+Your feature should be posted on https://github.com/dokato/connectivipy/issues
+and as specifically descripted as it can be. Consider including some
+links or references to external sources. Mayebe you'd like to consider
+your own contribution? Pull requests welcome though!
+
+## Fix bugs or implement new features
+
+Look through the GitHub [issues](https://github.com/dokato/connectivipy/issues)
+for features or bugs. Anything tagged with 
+"feature" / "bugs" is open to whoever wants to implement it or fix it.
+
+Get started!
+-----------
+
+If you are new to Git please read first [GitHub help pages](http://help.github.com/).
+
+In few simple steps you can set up `connectivipy` on your machine:
+
+1. Fork the `connectivipy` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/connectivipy.git
+
+3. Create a branch for local development:
+
+    $ cd connectivipy
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+5. Submit a pull request through the GitHub website.
+
+Remeber about writing test and validating your changes i.e. using
+nosetests. To run a subset of tests just type:
+
+	$ nosetests tests
+
+To get nosetests use pip. 
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring. Remember about
+   completeing CHANGELOG.md with your contribution.
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 ConnectiviPy
 =========================
-Python connectivity module.
-It is a part of [GSOC 2015](http://www.google-melange.com/gsoc/project/details/google/gsoc2015/dokato/5649050225344512) project.
-Project blog is [here](http://dokato.github.io/connpy-blog/).
+Python module for connectivity analysis. You may find here implementation
+of MVAR based estimators like DTF, PDC and others like Coherency, PSI.
+Project was supported by [GSOC 2015](http://www.google-melange.com/gsoc/project/details/google/gsoc2015/dokato/5649050225344512)
+and made under [INCF](http://incf.org/) wings.
 
 ## Content
 
@@ -31,45 +32,9 @@ Option 2: Download ZIP from the menu on the right, unzip it and go
 in terminal to that folder. Than just execute:
 
 ```
-python setup install 
+python setup.py install 
 ```
 
 ## Authors
 * Dominik Krzemiński
 * Maciej Kamiński (scientific lead)
-
-###Changelog
-
-#### 0.36
-* bug fixing
-* data loading improved
-* better plotting
-
-#### 0.34
-* short-time statistics
-* documentation in sphinx ready on readthedocs
-* visualization improved
-* conversion to trans3d
-* more examples
-
-#### 0.31
-* connectivity methods: gDTF, gPDC, Coherency, PSI, GCI
-* new mvar estimation criterion: FPE
-* statistics for multitrial (bootstrap) and normal case (surrogate data)
-* fitting mvar for multitrial
-* short-time versions of estimation
-* data plotting
-* working example
-
-#### 0.2
-* connectivity methods: DTF, PDC, Partial Coherence, iPDC
-* mvar estimation criterions
-* mvar class static
-
-#### 0.1
-* data class with simple preprocessing methods
-* mvar class almost done
-
-#### 0.05
-* project structure
-* basic fitting