Update master branch to main

This commit is contained in:
Tilen Majerle 2022-02-16 20:19:28 +01:00
parent 70f2170789
commit dc48190286

View File

@ -13,10 +13,10 @@ Download library
Library is primarly hosted on `Github <https://github.com/MaJerle/lwmem>`_.
You can get it with:
You can get it by:
* Downloading latest release from `releases area <https://github.com/MaJerle/lwmem/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
@ -34,11 +34,11 @@ 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/lwmem`` command to clone entire repository, including submodules
* Run ``git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwmem`` to clone `development` branch, including submodules
* Run ``git clone --recurse-submodules --branch master https://github.com/MaJerle/lwmem`` to clone `latest stable` branch, including submodules
* Run ``git clone --recurse-submodules --branch main https://github.com/MaJerle/lwmem`` to clone `latest stable` branch, including submodules
* Navigate to ``examples`` directory and run favourite example
@ -46,7 +46,7 @@ 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