From 9f5ba8c38fa61fee34840296782d5da5f903fd39 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sat, 4 Aug 2018 09:02:10 -0700 Subject: [PATCH] minor README fixes - typos, layouts, etc --- README.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 66e380dbd..835f1a1f6 100644 --- a/README.rst +++ b/README.rst @@ -42,9 +42,11 @@ data file suffixes and prefixes. .. contents:: **Contents** :backlinks: none -Get started +Quick start =========== +Please read `Get Started `_ for the full version. Common workflow commands include: + +-----------------------------------+-------------------------------------------------------------------+ | Step | Command | +===================================+===================================================================+ @@ -66,12 +68,10 @@ Get started | | | ``$ dvc push`` | +-----------------------------------+-------------------------------------------------------------------+ -Follow this link to learn more and get more details: `get started `_. - Installation ============ -It could be installed using ``pip``, Homebrew or an OS-specific package. +There are three options to install DVC: ``pip``, Homebrew, or an OS-specific package: .. code-block:: bash @@ -103,22 +103,21 @@ Related technologies don't want to see in your Git repository) in a local key-value store and uses file hardlinks/symlinks instead of the copying actual files. -#. `Git-LFS `_. - DVC is compatible with any remote storage (S3, Google Cloud, Azure, SSH, +#. `Git-LFS `_ - DVC is compatible with any remote storage (S3, Google Cloud, Azure, SSH, etc). DVC utilizes reflinks or hardlinks to avoid copy operation on checkouts which makes much more efficient for large data files. -#. Makefile (and its analogues). DVC tracks dependencies (DAG). +#. *Makefile* (and its analogues). DVC tracks dependencies (DAG). #. `Workflow Management Systems `_. DVC is a workflow management system designed specifically to manage machine learning experiments. DVC is built on top of Git. -DVC is compatible with Git for storing code and the dependency graph (DAG), but not data files cache. -To store and share data files cache DVC supports remotes - any cloud (S3, Azure, Google Cloud, etc) or any on-premise -network storage (via SSH, for example). - How DVC works ============= +DVC is compatible with Git for storing code and the dependency graph (DAG), but not data files cache. +To store and share data files cache DVC supports remotes - any cloud (S3, Azure, Google Cloud, etc) or any on-premise +network storage (via SSH, for example). .. image:: https://dvc.org/static/img/flow.png :target: https://dvc.org/static/img/flow.png