Skip to content

Commit

Permalink
@ #563 | use rst format
Browse files Browse the repository at this point in the history
  • Loading branch information
@datphan
datphan committed Jan 17, 2019
1 parent 9d2bede commit 18c130c
Showing 1 changed file with 34 additions and 42 deletions.
76 changes: 34 additions & 42 deletions docs/getting_started.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,11 @@ Please follow the installation instruction below, after that, the instruction st

Other platforms are expected to work, but we haven't fully tested them yet.

- If you're using a macOS machine,
:ref:`click here to jump to macOS installation <manual-installation-on-macos>`.
- If you're using a macOS machine, `click here to jump to macOS installation <manual-installation-on-macos_>`_.

- If you're using a Linux (Ubuntu) machine,
:ref:`click here to jump to Linux (Ubuntu) installation <manual-installation-on-linux-ubuntu>`.

- If you're using a Windows machine, [click here to jump to Windows manual installation](#manual-installation-on-windows)`.
- If you're using a Linux (Ubuntu) machine, `click here to jump to Linux (Ubuntu) installation <manual-installation-on-linux-ubuntu_>`_.

- If you're using a Windows machine, `click here to jump to Windows manual installation <manual-installation-on-windows-to-use-git-bash)>`_.

Automatic Installation on macOS
-------------------------------
Expand Down Expand Up @@ -88,7 +85,7 @@ Open the terminal window:
- // TODO(hoatle): https://github.com/teracyhq/dev/issues/175


Next: :ref:`teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up>`
Next: `teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up_>`_

Automatic Installation on Linux (Ubuntu)
----------------------------------------
Expand Down Expand Up @@ -139,18 +136,19 @@ Please check out the instruction video below for more details:

The video is not really up to date with current teracy-dev v0.5.0, however, you will see the similar workflow and result.

Next: :ref:`teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up>`
Next: `teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up_>`_

Automatic Installation on Windows
---------------------------------

// TODO(hoatle): add this

.. _manual-installation-on-windows-to-use-git-bash:

Manual Installation on Windows
------------------------------
Manual Installation on Windows to use Git Bash
----------------------------------------------

1. Install [chocolatey](https://chocolatey.org/install#installing-chocolatey):
1. Install `chocolatey <https://chocolatey.org/install#installing-chocolatey>`_:

Run ``Command Prompt`` **as administrator** and then copy this to your terminal window:

Expand All @@ -160,31 +158,36 @@ Manual Installation on Windows
After the installation is finished, restart the machine.

2. Install [git](https://git-scm.com/downloads) (>= 2.20.1):
2. Install `git <https://git-scm.com/downloads>`_ (>= 2.20.1):

.. code-block:: bash
$ choco install git.install --version 2.20.1
3. Install [virtualbox](https://www.virtualbox.org/) (>= 5.2.22):
3. Install `virtualbox <https://www.virtualbox.org/>`_ (>= 5.2.22):

.. code-block:: bash
$ choco install virtualbox --version 5.2.22
4. Install [vagrant](https://www.vagrantup.com/) (>= 2.2.2):
4. Install `vagrant <https://www.vagrantup.com/>`_ (>= 2.2.2):

.. code-block:: bash
$ choco install vagrant --version 2.2.2
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.
5. Install rsync for ```Git 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/

- Extract and copy ``rsync.exe`` to ``C:\Program Files\Git\usr\bin``, then re-open your terminal window.

.. _manual-installation-on-windows-deprecated:
Manual Installation on Windows (**DEPRECATED**)
-----------------------------------------------
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.

**This section is deprecated, please head over to the updated [Manual Installation on Windows](#manual-installation-on-windows)**
.. _manual-installation-on-windows-to-use-cygwin:

Manual Installation on Windows to use Cygwin
--------------------------------------------

This should be the same on Windows 10, Windows 8 and Windows 7.

Expand Down Expand Up @@ -301,7 +304,8 @@ Please check out the instruction video below for more details:

The video is not really up to date with current teracy-dev v0.5.0, however, you will see the similar workflow and result.

Next: :ref:`teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up>`

Next: `teracy-dev Git Clone and Vagrant Up <teracy-dev-git-clone-and-vagrant-up_>`_

.. _teracy-dev-git-clone-and-vagrant-up:

Expand Down Expand Up @@ -406,35 +410,23 @@ 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:**

- ~~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``

- (**DEPRECATED**) 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:

.. code-block:: bash

$ source ~/.bash_profile
.. note::

Now, open the terminal and run the ``export`` command to check if the variable is added successfully
- 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.

Rsync with Git Bash
-------------------
.. code-block:: bash
To use rsync with ``Git Bash``:
$ cat >> ~/.bash_profile
- 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/
Type ``export VAGRANT_PREFER_SYSTEM_BIN=true`` and press ``Ctrl + D``, then run:

- Extract and copy ``rsync.exe`` to ``C:\Program Files\Git\usr\bin``, then re-open your terminal window.
.. code-block:: bash
$ source ~/.bash_profile
Now, open the terminal and run the ``export`` command to check if the variable is added successfully

*Congratulations, you’ve all set now!*

0 comments on commit 18c130c

Please sign in to comment.