diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 7732f23f7bf..6be0a512c62 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -24,6 +24,11 @@ The Fabric application stack has five layers: * :doc:`Application APIs `: to develop your blockchain application. * The Application: your blockchain application will utilize the Application SDKs to call smart contracts running on a Fabric network. +For a quick local setup, start with :doc:`Fabric and Fabric samples `, which includes the +`install-fabric.sh` script for downloading Fabric binaries, container images, and the samples repository. +If you want to modify Fabric itself, continue afterwards with the +:doc:`development environment `. + .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/install.md b/docs/source/install.md index c07bde517f5..d9ed382fea7 100644 --- a/docs/source/install.md +++ b/docs/source/install.md @@ -22,6 +22,18 @@ The `install-fabric.sh` script introduced in the next section automates the proc * `fabric-ca-client`, * `fabric-ca-server` +## Which setup path should I use? + +For most users who want a working local Fabric environment with a single script, the recommended path is: + +1. Install the required software from [Prerequisites](./prereqs.html). +2. Run `install-fabric.sh` to download the Fabric binaries, Docker images, and optionally `fabric-samples`. +3. Use the `fabric-samples` test network and tutorials to start a local network and deploy chaincode. + +If you want to contribute to Fabric itself, use this install flow first and then continue with the +[contributor development environment](./dev-setup/devenv.html), which adds the extra tools and steps +needed to build Fabric and run its test suites. + ## Download Fabric samples, Docker images, and binaries A working directory is required - for example, Go Developers use the `$HOME/go/src/github.com/` directory.  This is a Golang Community recommendation for Go projects.