Skip to content

Commit

Permalink
A basic read me file
Browse files Browse the repository at this point in the history
  • Loading branch information
dimazest committed Oct 17, 2013
1 parent 867123a commit dbeb850
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
DIStributional SEmantics Composition Toolkit
============================================

Installation
------------

To install the package run:

pip install dissect

Development
-----------

To run the tests execute::

python setup.py test

To install the package in an isolated environment for development run::

virtualenv .
source bin/activate

pip install -e .
pip install pytest # And any other tools you find useful.

Now you are ready to develop and test your changes::

py.test src/unitest

If you want to execute some of the tests run (for example, similarity related)::

py.test src/unitest -k similarity

Read py.test documentation and have fun coding!

0 comments on commit dbeb850

Please sign in to comment.