.. libmcu documentation master file, created by
   sphinx-quickstart on Sun Jan 28 07:25:31 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. rst-class:: pure-button

	`한글 <https://libmcu.org/ko>`_

.. rst-class:: pure-button

	`English <https://libmcu.org>`_

Development Toolkit for Microcontrollers
========================================

.. |logo_ref| image:: _static/icon/logo_horizontal.svg
    :width: 130px
    :alt: libmcu

`libmcu` for developing robust firmware that is platform and hardware agnostic. POSIX-compliant and abstracted interfaces make more code reusability irrespective of the RTOS and hardwares in use.

It helps you focus on your application, not on platform-specific or/and manufacturer-specific development environment. It also provides useful libraries to increase development productivity.

Features
--------

* Simplicity and code size are considered first
* No dynamic memory allocation
* Written in C99
* No linker script tweak required
* Open source
* Scalability and flexibility

Contributing to |logo_ref|
--------------------------

All types of contributions are encouraged and valued. We want to make contributing to this project as easy and transparent as possible, whether it's:

* Reporting a bug
* Discussing the current state of the code
* Submitting a fix
* Proposing new features
* Becoming a maintainer

Pull requests are the best way to propose changes to the codebase as we use `Github Flow <https://guides.github.com/introduction/flow/index.html>`_. We actively welcome your pull requests:

#. Fork the repo and create your branch from ``main``
#. If you've added code that should be tested, add tests
#. If you've changed APIs, update the documentation
#. Ensure the test suite passes
#. Issue that pull request

Alternatively you may ask anything `here <https://github.com/orgs/libmcu/discussions/new?category=q-a>`_.

.. note::
   And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

   * Star the project
   * Refer this project in your project's readme
   * `Sponsor <https://github.com/sponsors/libmcu>`_ the project to keep it going

Contents
--------

.. toctree::
   :maxdepth: 2

   get-started/index
   user-manual/index
   api-reference/index
   library/index
   example/index
   hardware/index

License
-------

.. literalinclude:: ../libmcu/LICENSE