--- a +++ b/docs/getting-started.rst @@ -0,0 +1,19 @@ +Getting started +=============== + +Quick Start +----------- +Installation +```````````` +git clone https://github.com/smujiang/WSITools.git +cd WSITools +python setup.py install + +Note that when you install our package, the dependencies can be automatically installed, but you may need to install +the dependent OpenSlide_ library. +If using `PyCharm` or `venv` on Windows: +1. Download the correct binary_ file for your system +2. Copy all files from `/bin` into your `venv/Scripts/` directory + +.. _OpenSlide: https://openslide.org +.. _binary: https://openslide.org/download/#windows-binaries \ No newline at end of file