diff --git a/docs/getting_started.rst b/docs/getting_started.rst index d6bd3d1a..be6a7bd2 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -31,8 +31,7 @@ Please follow the installation instruction below, after that, the instruction st - If you're using a Linux (Ubuntu) machine, :ref:`click here to jump to Linux (Ubuntu) installation `. -- If you're using a Windows machine, - :ref:`click here to jump to Windows installation `. +- If you're using a Windows machine, [click here to jump to Windows manual installation](#manual-installation-on-windows)`. Automatic Installation on macOS @@ -147,11 +146,30 @@ Automatic Installation on Windows // TODO(hoatle): add this -.. _manual-installation-on-windows: Manual Installation on Windows ------------------------------ +1. Install ``git``: + +Head over to https://git-scm.com/downloads and download their latest release then follow the instruction, by then you will have ``Git Bash`` already installed. + +2. Install ``virtualbox``: + +Head over to https://www.virtualbox.org/ and download their latest release then follow the instruction, by then you will have ``virtualbox`` already installed. + +3. Install ``vagrant``: + +Head over to https://www.vagrantup.com/ and download their latest release then follow the instruction, by then you will have ``vagrant`` already installed. + +Now everything is done, head over to [teracy-dev Git Clone and Vagrant Up](#teracy-dev-git-clone-and-vagrant-up) to continue the setup. + +.. _manual-installation-on-windows-deprecated: +Manual Installation on Windows (**DEPRECATED**) +----------------------------------------------- + +This section is deprecated, please head over to the updated [Manual Installation on Windows](#manual-installation-on-windows) + This should be the same on Windows 10, Windows 8 and Windows 7. Follow step by step instructions below: @@ -372,25 +390,35 @@ Git Setup To work with ``git``, complete the following guides to set up ssh keys: https://help.github.com/articles/connecting-to-github-with-ssh/ - .. note:: +**Note:** + + - ~~On Windows, you must always use ``Cygwin Terminal``, not ``Git Bash``~~. + + - ``Cygwin Terminal`` is now deprecated and no longer support, we are now using ``Git Bash`` + + - (**DEPRECSTED**) If you have SSH configured and ``vagrant`` is still not working on Windows, you should add the ``export VAGRANT_PREFER_SYSTEM_BIN=true`` environment variable to the ``.bash_profile`` file, that helps you not add this variable on Cygwin repeatedly.!! + + .. code-block:: bash + + $ cat >> ~/.bash_profile + + Type ``export VAGRANT_PREFER_SYSTEM_BIN=true`` and press ``Ctrl + D``, then run: - - On Windows, you must always use ``Cygwin Terminal``, not ``Git Bash``. + .. code-block:: bash - - If you have SSH configured and ``vagrant`` is still not working on Windows, you should add the - ``export VAGRANT_PREFER_SYSTEM_BIN=true`` environment variable to the ``.bash_profile`` file, that helps you - not add this variable on Cygwin repeatedly. + $ source ~/.bash_profile - .. code-block:: bash + Now, open the terminal and run the ``export`` command to check if the variable is added successfully - $ cat >> ~/.bash_profile +Rsync with Git Bash +------------------- - Type ``export VAGRANT_PREFER_SYSTEM_BIN=true`` and press ``Ctrl + D``, then run: +To use rsync with `Git Bash`: - .. code-block:: bash +download [rsync-3.1](http://www2.futureware.at/~nickoe/msys2-mirror/msys/x86_64/rsync-3.1.2-2-x86_64.pkg.tar.xz) at http://www2.futureware.at/~nickoe/msys2-mirror/msys/x86_64/ - $ source ~/.bash_profile +extract and copy `rsync.exe` to `C:\Program Files\Git\usr\bin`, then re-open your terminal window. - Now, open the terminal and run the ``export`` command to check if the variable is added successfully -*Congratulations, you’ve all set now!* \ No newline at end of file +*Congratulations, you’ve all set now!*