Applying new .gitignore

This commit is contained in:
Tilen Majerle 2019-12-07 00:31:05 +01:00
parent b885a0c065
commit bd1ee1f9d3
4 changed files with 42 additions and 12 deletions

1
.gitignore vendored
View File

@ -23,6 +23,7 @@
*.__i
*.i
*.txt
!docs/*.txt
RTE/
# IAR Settings

View File

@ -1,6 +1,8 @@
LwMEM documentation!
====================
LwMEM is lightweight dynamic memory manager optimized for embedded systems.
.. image:: static/images/logo.svg
:align: center
@ -11,22 +13,21 @@ LwMEM documentation!
Features
^^^^^^^^
- Written in ANSI C99, compatible with ``size_t`` for size data types
- Platform independent, no architecture specific code
- FIFO (First In First Out) buffer implementation
- No dynamic memory allocation, data is static array
- Uses optimized memory copy instead of loops to read/write data from/to memory
- Thread safe when used as pipe with single write and single read entries
- Interrupt safe when used as pipe with single write and single read entries
- Suitable for DMA transfers from and to memory with zero-copy overhead between buffer and application memory
- Supports data peek, skip for read and advance for write
- User friendly MIT license
* Written in ANSI C99, compatible with size_t for size data types
* Implements standard C library functions for memory allocation, malloc, calloc, realloc and free
* Uses first-fit algorithm to search free block
* Supports different memory regions to allow use of fragmented memories
* Suitable for embedded applications with fragmented memories
* Suitable for automotive applications
* Supports advanced free/realloc algorithms to optimize memory usage
* Operating system ready, thread-safe API
* User friendly MIT license
Requirements
^^^^^^^^^^^^
- C compiler
- Less than ``2kB`` of memory
* C compiler
* Less than ``2kB`` of memory
Contribute
^^^^^^^^^^

21
docs/license.txt Normal file
View File

@ -0,0 +1,21 @@
Copyright (c) 2019 Tilen MAJERLE
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

7
docs/requirements.txt Normal file
View File

@ -0,0 +1,7 @@
breathe>=4.9.1
colorama
docutils>=0.14
sphinx>=2.0.1
sphinx_rtd_theme
sphinx-tabs
sphinxcontrib-svg2pdfconverter