diff --git a/doc/source/install.txt b/doc/source/install.txt new file mode 100644 index 00000000..4c8e511d --- /dev/null +++ b/doc/source/install.txt @@ -0,0 +1,25 @@ +Installation from source +------------------------ + +Obtain the source from the git-repository at +`http://github.com/stefanv/scikits.gpu +`_. + +The SciKit can be installed globally using + +:: + + python setup.py install + +or locally using + +:: + + python setup.py install --prefix=${HOME} + +If you prefer, you can use it without installing, by simply adding +this path to your PYTHONPATH variable and compiling extensions +in-place:: + + python setup.py build_ext -i + diff --git a/doc/source/overview.txt b/doc/source/overview.txt new file mode 100644 index 00000000..5b3ea7a9 --- /dev/null +++ b/doc/source/overview.txt @@ -0,0 +1,24 @@ +Image Processing SciKit +======================= + +This SciKit (toolkit for `SciPy `_) includes +useful image processing algorithms for use with `Python +`_ and `NumPy `_. +While SciPy's ``ndimage`` provides low-level manipulation, +``scikits.image`` centres around algorithms and applications. + +This `SciKit `_ is developed by the SciPy +community. All contributions are most welcome! Please join us on the +mailing list (address provided below). + +Source, bugs and patches +------------------------ +http://github.com/stefanv/scikits.gpu + +Mailing List +------------ +http://groups.google.com/group/scikits-image + +Contact +------- +Stefan van der Walt