Skip to content

Commit

Permalink
Update master branch to main
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Feb 16, 2022
1 parent 1235f13 commit 9d90e55
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Download library

Library is primarly hosted on `Github <https://github.com/MaJerle/lwow>`_.

You can get it with:
You can get it by:

* Downloading latest release from `releases area <https://github.com/MaJerle/lwow/releases>`_ on Github
* Cloning ``master`` branch for latest stable version
* Cloning ``main`` branch for latest stable version
* Cloning ``develop`` branch for latest development

Download from releases
Expand All @@ -34,19 +34,19 @@ This is used when you do not have yet local copy on your machine.

* Make sure ``git`` is installed.
* Open console and navigate to path in the system to clone repository to. Use command ``cd your_path``
* Clone repository with one of available ``3`` options
* Clone repository with one of available options below

* Run ``git clone --recurse-submodules https://github.com/MaJerle/lwow`` command to clone entire repository, including submodules
* Run ``git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwow`` to clone `development` branch, including submodules
* Run ``git clone --recurse-submodules --branch master https://github.com/MaJerle/lwow`` to clone `latest stable` branch, including submodules
* Run ``git clone --recurse-submodules --branch main https://github.com/MaJerle/lwow`` to clone `latest stable` branch, including submodules

* Navigate to ``examples`` directory and run favourite example

Update cloned to latest version
"""""""""""""""""""""""""""""""

* Open console and navigate to path in the system where your repository is located. Use command ``cd your_path``
* Run ``git pull origin master`` command to get latest changes on ``master`` branch
* Run ``git pull origin main`` command to get latest changes on ``main`` branch
* Run ``git pull origin develop`` command to get latest changes on ``develop`` branch
* Run ``git submodule update --init --remote`` to update submodules to latest version

Expand Down

0 comments on commit 9d90e55

Please sign in to comment.