mirror of
https://github.com/MaJerle/lwmem.git
synced 2025-01-26 06:02:54 +08:00
79 lines
2.9 KiB
ReStructuredText
79 lines
2.9 KiB
ReStructuredText
.. _get_started:
|
|
|
|
Get started
|
|
===========
|
|
|
|
.. _download_library:
|
|
|
|
Download library
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
Library is primarly hosted on `Github <https://github.com/MaJerle/lwmem>`_.
|
|
|
|
* Download latest release from `releases area <https://github.com/MaJerle/lwmem/releases>`_ on Github
|
|
* Clone `develop` branch for latest development
|
|
|
|
Download from releases
|
|
**********************
|
|
|
|
All releases are available on Github `releases area <https://github.com/MaJerle/lwmem/releases>`_.
|
|
|
|
Clone from Github
|
|
*****************
|
|
|
|
First-time clone
|
|
""""""""""""""""
|
|
|
|
* Download and install ``git`` if not already
|
|
* 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
|
|
|
|
* 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
|
|
|
|
* Navigate to ``examples`` directory and run favourite example
|
|
|
|
Update cloned to latest version
|
|
"""""""""""""""""""""""""""""""
|
|
|
|
* Open console and navigate to path in the system where your resources repository is. Use command ``cd your_path``
|
|
* Run ``git pull origin master --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules
|
|
* Run ``git submodule foreach git pull origin master`` to update & merge all submodules
|
|
|
|
.. note::
|
|
This is preferred option to use when you want to evaluate library and run prepared examples.
|
|
Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
|
|
|
|
Add library to project
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
At this point it is assumed that you have successfully download library, either cloned it or from releases page.
|
|
|
|
* Copy ``lwmem`` folder to your project
|
|
* Add ``lwmem/src/include`` folder to `include path` of your toolchain
|
|
* Add source files from ``lwmem/src/`` folder to toolchain build
|
|
* Copy ``lwmem/src/include/lwmem/lwmem_config_template.h`` to project folder and rename it to ``lwmem_config.h``
|
|
* Build the project
|
|
|
|
Configuration file
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
Library comes with template config file, which can be modified according to needs.
|
|
This file shall be named ``lwmem_config.h`` and its default template looks like the one below:
|
|
|
|
.. tip::
|
|
Check :ref:`api_lwmem_config` section for possible configuration settings
|
|
|
|
.. literalinclude:: ../../lwmem/src/include/lwmem/lwmem_config_template.h
|
|
:language: c
|
|
:caption: Config file template
|
|
|
|
Minimal example code
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Run below example to test and verify library
|
|
|
|
.. literalinclude:: ../examples_src/example_minimal.c
|
|
:language: c
|
|
:caption: Absolute minimum example |