[med-svn] [python-mne] 373/376: updating README

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to annotated tag v0.1
in repository python-mne.

commit 768d149519de1d5cfa35fc8223338495ad9c0957
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Fri Sep 23 13:50:05 2011 -0400

    updating README
---
 README.rst | 119 ++++++++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 78 insertions(+), 41 deletions(-)

diff --git a/README.rst b/README.rst
index 3f15711..5adf66b 100755
--- a/README.rst
+++ b/README.rst
@@ -1,27 +1,46 @@
 .. -*- mode: rst -*-
 
-About
-=====
+The homepage of MNE with user documentation is located on:
 
-MNE is a Python module for processing MEG and EEG data.
+http://martinos.org/mne
 
-It is a project initiated:
+Getting the latest code
+=========================
 
-Athinoula A. Martinos Center for Biomedical Imaging
-Massachusetts General Hospital
-Charlestown, MA, USA
+To get the latest code using git, simply type::
 
-Available under the very permissive BSD (3-clause) license.
+    git clone git://github.com/mne-tools/mne-python.git
 
-Even if this code is primarily developed at the Martinos Center,
-the purpose of opening it is to welcome contributions and feedback
-from users. This code is not the property of MGH / Martinos Center,
-so feel free to use it, modify it and add your name to this project.
+If you don't have git installed, you can download a zip or tarball
+of the latest code: http://github.com/mne-tools/mne-python/archives/master
 
-Download
-========
+Installing
+==========
 
-Just click on the *Downloads* button at https://github.com/mne-tools/mne-python
+As any Python packages, to install mne-python, simply do::
+
+    python setup.py install
+
+in the source code directory.
+
+You can also install the latest release with easy_install::
+
+    easy_install -U mne
+
+or with pip::
+
+    pip install mne --upgrade
+
+Workflow to contribute
+=========================
+
+To contribute to mne-python, first create an account on `github
+<http://github.com/>`_. Once this is done, fork the `mne-python repository
+<http://github.com/mne-tools/mne-python>`_ to have you own repository,
+clone it using 'git clone' on the computers where you want to work. Make
+your changes in your clone, push them to your github account, test them
+on several computer, and when you are happy with them, send a pull
+request to the main repository.
 
 Dependencies
 ============
@@ -33,46 +52,64 @@ To run the tests you will also need nose >= 0.10.
 and the MNE sample dataset (will be downloaded automatically
 when you run an example ... but be patient)
 
-Install
-=======
+Mailing list
+============
 
-This packages uses distutils, which is the default way of installing
-python modules. The install command is::
+http://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis
 
-  python setup.py install
+Running the test suite
+=========================
 
+To run the test suite, you need nosetests and the coverage modules.
+Run the test suite using::
 
-Mailing list
-============
+    nosetests
 
-http://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis
+from the root of the project.
+
+Making a release and uploading it to PyPI
+==================================================
 
-Development
-===========
+This command is only run by project manager, to make a release, and
+upload in to PyPI::
 
-Code
-----
+    python setup.py sdist bdist_egg register upload
 
-GIT
-~~~
 
-You can check the latest sources with the command::
+Licensing
+----------
 
-    git clone git://github.com:mne-tools/mne-python.git
+mne-python is **BSD-licenced** (3 clause):
 
-or if you have write privileges::
+    This software is OSI Certified Open Source Software.
+    OSI Certified is a certification mark of the Open Source Initiative.
 
-    git clone git at github.com:mne-tools/mne-python.git
+    Copyright (c) 2011, Alexandre Gramfort
+    All rights reserved.
 
-Bugs
-----
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
 
-Please report bugs you might encounter to:
-gramfort at nmr.mgh.harvard.edu
-or even better, *open an issue* on github.
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
 
-Testing
--------
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
 
-You can launch the test suite using nosetests from the source folder.
+    * Neither the name of Alexandre Gramfort. nor the names of other mne
+      contributors may be used to endorse or promote products derived from 
+      this software without specific prior written permission.
 
+    **This software is provided by the copyright holders and contributors
+    "as is" and any express or implied warranties, including, but not
+    limited to, the implied warranties of merchantability and fitness for
+    a particular purpose are disclaimed. In no event shall the copyright
+    owner or contributors be liable for any direct, indirect, incidental,
+    special, exemplary, or consequential damages (including, but not
+    limited to, procurement of substitute goods or services; loss of use,
+    data, or profits; or business interruption) however caused and on any
+    theory of liability, whether in contract, strict liability, or tort
+    (including negligence or otherwise) arising in any way out of the use
+    of this software, even if advised of the possibility of such
+    damage.**

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git