From b50ae956d5ef6547b3a5357c2a2f8aa49540a7b7 Mon Sep 17 00:00:00 2001
From: Thamme Gowda <thammegowda@microsoft.com>
Date: Tue, 29 Aug 2023 09:34:54 -0700
Subject: [PATCH] Fix typos and sync README -> docs/intro.rst

---
 README.md             |  6 +++---
 docs/README.md        |  7 ++++++-
 docs/introduction.rst | 43 +++++++++++++++++++++++--------------------
 3 files changed, 32 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 2efecc2..a7ae52c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Sotastream 
+# Sotastream
 [![image](http://img.shields.io/pypi/v/sotastream.svg)](https://pypi.python.org/pypi/sotastream/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
 [![Read the Docs](https://img.shields.io/readthedocs/sotastream.svg)](https://sotastream.readthedocs.io/)
@@ -23,9 +23,9 @@ pip install sotastream
 # To begin, clone the repository:
 git clone https://github.com/marian-nmt/sotastream
 cd sotastream
-# option 1: 
+# option 1:
 python -m pip install .
-# option 2: install in --editable model
+# option 2: install in --editable mode
 python -m pip install -e .
 ```
 
diff --git a/docs/README.md b/docs/README.md
index 555a592..9728bde 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -25,4 +25,9 @@ python -m build --sdist --wheel -o dist/
 twine upload -r testpypi dist/*
 twine upload -r pypi dist/*
 
-```
\ No newline at end of file
+```
+
+
+## Update Docs
+
+Go to https://readthedocs.org/projects/sotastream/ and click/touch "Build" button.
diff --git a/docs/introduction.rst b/docs/introduction.rst
index f4327b9..32b2c83 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -10,31 +10,37 @@ uses `infinibatch <https://github.com/microsoft/infinibatch>`_ internally to gen
 shuffled training data and provides a means for on-the-fly data
 manipulation, augmentation, mixing, and sampling.
 
-Cloning and initialization
---------------------------
 
-To begin, clone the repository:
 
-::
 
-   git clone https://github.com/marian-nmt/sotastream
+Setup
+-----
+
+To install from PyPI (https://pypi.org/project/sotastream/)
 
-You can then install it as follows.
 
 .. code:: bash
 
-   cd sotastream
+   pip install sotastream
+
+
+*Developer Setup:*
 
+.. code:: bash
+
+   # To begin, clone the repository:
+   git clone https://github.com/marian-nmt/sotastream
+   cd sotastream
+   # option 1: 
    python -m pip install .
-   python -m pip install --no-deps .   # install without dependencies
+   # option 2: install in --editable mode
+   python -m pip install -e .
+
 
-If you already have your own version of requirements, add
-``--no-deps / --no-dependencies`` flag to skip installing dependencies.
+*Entry points*
+* As a module:  `python -m sotastream`
+* As a bin in your $PATH: `sotastream`
 
-Entry points \* As a module: ``python -m sotastream`` \* As a bin in
-your $PATH: ``sotastream`` \* Via path to script:
-``python path/to/cli.py``. For convenience, cli.py is in the root of
-repository
 
 Development
 -----------
@@ -94,11 +100,8 @@ sotastream will split them to checksummed folders under
 
    python -m sotastream example parallel.tsv.gz backtrans.tsv.gz
 
-(The garbage file is assumed to have just a single column of data, which
-is copied).
-
-There are currently two main pipelines: “default”, and “wmt”. These vary
-according to the data sources they take as well as the other options
+There are currently two main pipelines: “default”, and “wmt”.
+These vary according to the data sources they take as well as the other options
 available to them.
 
 There are global options that control behavioral aspects such as
@@ -116,7 +119,7 @@ can see these by running
    # see wmt pipeline options
    python -m sotastream wmt -h
 
-Don’t cross the streams!
+Don't cross the streams!
 ------------------------
 
 Sotastream workflows build a directed acyclic graph (DAG) consisting of