Commit cc21f7de authored by Gari Singh's avatar Gari Singh Committed by Gerrit Code Review
Browse files

Merge "[FAB-5484] Fixes documentation for Windows users"

parents 258b25c8 1b6820a2
......@@ -4,8 +4,10 @@ Prerequisites
Install cURL
------------
Download the `cURL <https://curl.haxx.se/download.html>`__ tool if not
already installed.
Download the latest version of the `cURL
<https://curl.haxx.se/download.html>`__ tool if it is not already
installed or if you get errors running the curl commands from the
documentation.
.. note:: If you're on Windows please see the specific note on `Windows
extras`_ below.
......@@ -59,6 +61,7 @@ source code is located somewhere within the ``$GOPATH`` tree. First, you will
need to check that you have set your ``$GOPATH`` environment variable.
.. code:: bash
echo $GOPATH
/Users/xxx/go
......@@ -95,18 +98,16 @@ installed.
Windows extras
--------------
If you are developing on Windows, you may also need the following which
provides a better alternative to the built-in Windows tools:
- `Git Bash <https://git-scm.com/downloads>`__
If you are developing on Windows, you will want to work within the
Docker Quickstart Terminal which provides a better alternative to the
built-in Windows such as `Git Bash <https://git-scm.com/downloads>`__
which you typically get as part of installing Docker Toolbox on
Windows 7.
.. note:: On older versions of Windows, such as Windows 7, you
typically get this as part of installing Docker
Toolbox. However experience has shown this to be a poor
development environment with limited functionality. It is
suitable to run Docker based scenarios, such as
:doc:`getting_started`, but you may not be able to find a
suitable ``make`` command.
However experience has shown this to be a poor development environment
with limited functionality. It is suitable to run Docker based
scenarios, such as :doc:`getting_started`, but you may have
difficulties with operations involving the ``make`` command.
Before running any ``git clone`` commands, run the following commands:
......@@ -141,6 +142,16 @@ See the `NPM windows-build-tools page
<https://www.npmjs.com/package/windows-build-tools>`__ for more
details.
Once this is done, you should also install the NPM GRPC module with the
following command:
.. code:: bash
npm install --global grpc
Your environment should now be ready to go through the
:doc:`getting_started` samples and tutorials.
.. note:: If you have questions not addressed by this documentation, or run into
issues with any of the tutorials, please visit the :doc:`questions`
page for some tips on where to find additional help.
......
......@@ -2,7 +2,7 @@ Hyperledger Fabric Samples
==========================
.. note:: If you are running on **Windows** you will want to make use of the
``Git bash shell`` extension for the upcoming terminal commands.
Docker Quickstart Terminal for the upcoming terminal commands.
Please visit the :doc:`prereqs` if you haven't previously installed
it.
......@@ -46,10 +46,16 @@ you will extract the platform-specific binaries:
curl -sSL https://goo.gl/iX9dek | bash
.. note:: If you get an error running the above curl command, you may
have too old a version of curl. Please visit the
:doc:`prereqs` page for additional information on where to
find the latest version.
The curl command above downloads and executes a bash script
that will download and extract all of the platform-specific binaries you
will need to set up your network and place them into the cloned repo you
created above. It retrieves four platform-specific binaries:
* ``cryptogen``,
* ``configtxgen``,
* ``configtxlator``, and
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment