Skip to content

Commit

Permalink
psychopy merge related changes
Browse files Browse the repository at this point in the history
  • Loading branch information
isolver committed May 8, 2013
1 parent 57fe499 commit bbb271f
Showing 1 changed file with 7 additions and 54 deletions.
61 changes: 7 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,66 +5,19 @@ real-time reporting, and persistant storage of input device events on a system w
for experiment device monitoring during a psychopolgy or neuroscience type study, ioHub is designed to be used
with the most excellent [PsychoPy](http://www.psychopy.org).

>> Note: In the near future **ioHub will be merging with PsychoPy ( psychopy.iohub )**, so it can be used
>> Note: **ioHub has merged with PsychoPy ( psychopy.iohub )**, so it can be used
>> out of the box with a PsychoPy installation, even if the desire is to use the ioHub event reporting
>> features in a 'headless' mode that does not create any windows or graphics.
>>
>> This will effect (in a positive way) how ioHub can be installed, where documentation is found,
>> and how to get support for the ioHub Event Framework.
>>
>> Stay tuned for updated on this exciting development !
## Status, Issues, To Do's

See the Issue Tracker on the projects Github page for an up to date list of outstanding issues,
features that still need to be completed, and other To-Do's. The project documentation also has information on
outstanding issues and tasks related to some device implementations.

## Download

**Note that the provided setup.py file is currently broken, and will be fixed ASAP. For now simply download the source distribution and copy the internal 'iohub' folder (all lower case folder name) to your python path; for example your site-packages folder. Sorry for the inconvience.**

ioHub source is hosted on GitHub [here](https://www.github.com/isolver/ioHub/).

Download the source, uncompress the file downloaded, open a terminal or console in the
uncompressed directory location, and run::

>> python setup.py install

---

**Information on downloading a pre-configured python environment for Windows that includes everything
needed to use ioHub with Python 2.7 can be found in the Installation page of the
[project documentation](http://www.isolver-solutions.com/iohubdocs/0.7/index.html).**
>> Please visit the [PsychoPy website](http://www.psychopy.org) for download and support options.
>>
>> This GitHub project will remain active so existing bugs and feature requests can continue to be tracked,
>> and as a source for the latest non-psychopy integrated version of the code. This code base will not longer be
>> updated. Future ioHub updates will be done within the PsychoPy GitHub project, in the psychopy.iohub submodule.
## Documentation

The documentation, which is **still being completed** (firm completion date of May 3rd), is now available
[online](http://www.isolver-solutions.com/iohubdocs/0.7/index.html).

If you would like to help by correcting grammatical errors, spelling,
filling in incomplete doc strings, etc, (which would be greatly apprieciated)
please make a fork of the ioHub project to your github account, make changes
to the master branch docs, and submit a pull request back to isolver/ioHub to have the updates merged.

The ioHub source contains a documentation folder that has been written using Sphinx.
If the ioHub source is downloaded, open a console or terminal window in the
iohub/doc/ directory and build the documentation using::

>> make html

[Sphinx](http://sphinx-doc.org/#) must be installed.

## Installation

Please refer to the Installation section of the
[documentation](http://www.isolver-solutions.com/iohubdocs/0.7/index.html).

## Support

A [user forum / mailing list](https://groups.google.com/forum/?hl=en&fromgroups#!forum/iohub-users)
and [developer forum / mailing list](https://groups.google.com/forum/?hl=en&fromgroups#!forum/iohub-dev)
are available on Google Groups for support questions and development discussion topics respectively.
The documentation for ioHub functionality can be found [online here](http://www.isolver-solutions.com/iohubdocs/index.html), until it has been merged with the PsychoPy documentation.

## License

Expand Down

0 comments on commit bbb271f

Please sign in to comment.