update installation methods and documentation (#10)

* update installation methods and documentation

* update

* fix doc

README.md

@@ -26,24 +26,38 @@ Please see our [documentation](https://squirrel-datasets-core.readthedocs.io) fo
 If you have any questions or would like to contribute, join our Slack community!
 
 # Installation
-Squirrel Datasets Core requires the latest stable version of Squirrel Core to be installed:
+Currently, we have not released a functional version of `squirrel-core` and `squirrel-datasets-core` into the public 
+pypi registry. Therefore we ask you to use the following installation method, which uses the source code directly:
 
+First, you need to clone the `squirrel-core` and `squirrel-datasets-core` repositories by:
 ```shell
-pip install squirrel-core
+git clone https://github.com/merantix-momentum/squirrel-core.git
 ```
-
-Install Squirrel Datasets Core via:
-
+and 
+```shell
+git clone https://github.com/merantix-momentum/squirrel-datasets-core.git
+```
+Then you can install both packages by
 ```shell
-pip install squirrel-datasets-core
+pip install -e squirrel-core
 ```
+and
+```shell
+pip install -e squirrel-core-datasets
+```
+
+In the documentation, you may also see some requirements to install the two packages first, please follow the 
+instruction above, instead of installing from public pypi registry (e.g `pip install squirrel-core` or 
+`pip install squirrel-datasets-core`). We kindly ask for your patience.
 
 # Documentation
 
-To view the docs locally, please use the following command in root directory of this repo:
+To view the docs locally, please use the following command in root directory of `squirrel-datasets-core`:
 ```
-sphinx-build ./docs/source ./docs/build && open ./docs/build/index.html
+sphinx-build ./docs/source ./docs/build
 ```
+The command above will create all documentation pages under `./docs/build`.
+To view the start page, open `./docs/build/index.html` in your browser. 
 
 # Contributing
 Squirrel is open source and community contributions are welcome!

docs/source/index.rst

@@ -1,6 +1,6 @@
 Squirrel Datasets Documentation
 ===============================
-`Squirrel Datasets <https://github.com/merantix-momentum/squirrel-datasets-core>`_ is an extension of the Squirrel platform for data transform, access, and discovery. 
+`Squirrel Datasets <https://github.com/merantix-momentum/squirrel-datasets-core>`_ is an extension of the Squirrel platform for data transform, access, and discovery.
 It includes common drivers for public datasets, which are ready to use along with data preprocessing logic.
 Visit the official `Squirrel Documentation <https://squirrel.readthedocs.io>`_ on more information how to use Squirrel.
 
@@ -12,8 +12,14 @@ Available Datasets
 .. toctree::
    :maxdepth: 2
 
-   dataset_links/kaggle_casting_quality   
+   dataset_links/allenai_c4
+   dataset_links/camvid
+   dataset_links/cc100
+   dataset_links/conceptual_captions
+   dataset_links/datascience_bowl
+   dataset_links/kaggle_casting_quality
    dataset_links/imagenet
+   dataset_links/monthly_german_tweets
 
 Contribute
 ------------------