https://github.com/lukems/uys
UYS - Useful Yet Simple (C libraries collection)
https://github.com/lukems/uys
Last synced: 9 months ago
JSON representation
UYS - Useful Yet Simple (C libraries collection)
- Host: GitHub
- URL: https://github.com/lukems/uys
- Owner: LukeMS
- License: mit
- Created: 2017-11-20T18:39:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-24T11:41:14.000Z (over 8 years ago)
- Last Synced: 2025-02-28T10:35:42.687Z (about 1 year ago)
- Language: C
- Homepage: https://lukems.github.io/uys/index.html
- Size: 387 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.pre.rst
- License: LICENSE
Awesome Lists containing this project
README
UYS - Useful Yet Simple (C libraries collection)
===========================================================
|version_badge|_ |travisci_badge|_ |codacy_badge|_ |codecov_badge|_ |doxycoverage_badge|_
.. |version_badge| image:: https://badge.fury.io/gh/LukeMS%2Fuys.svg
.. _version_badge: https://badge.fury.io/gh/LukeMS%2Fuys
.. |travisci_badge| image:: https://travis-ci.org/LukeMS/uys.svg?branch=master
.. _travisci_badge: https://travis-ci.org/LukeMS/uys
.. |codacy_badge| image:: https://api.codacy.com/project/badge/Grade/cbc2da745aa64cb5944b412eb55f613a
.. _codacy_badge: https://www.codacy.com/app/LukeMS/uys?utm_source=github.com&utm_medium=referral&utm_content=LukeMS/uys&utm_campaign=Badge_Grade
.. |codecov_badge| image:: https://codecov.io/gh/LukeMS/uys/branch/master/graph/badge.svg
.. _codecov_badge: https://codecov.io/gh/LukeMS/uys
.. |doxycoverage_badge| image:: https://lukems.github.io/uys/doxy-coverage.svg
.. _doxycoverage_badge: https://lukems.github.io/uys/doxy-coverage.txt
.. contents::
About
******
A collection of C libraries with some useful data types and functions, providing some frequently needed features that the standard library does not offer.
Most of the content comes from existing libraries/code, modified when deemed necessary to provide a reasonably cohesive API, good documentation and testing.
UYS goals
**********
The collection, as a whole, aims to be:
* Simple (to install, understand and use);
* Useful, providing some data types and functions that the standard library does not offer;
* Well documented;
* Well tested;
* Cohesive;
* Portable: (at least) Windows, Linuxes and Macs should be supported (relying on Continuous Integration Services to test them);
3rd party libraries
********************
* list.c/list.h are a modified version of the linked list algorithm presented in the book "`Mastering Algorithms with C`_" (1999) by Kyle Loudon, published by O'Reilly & Associates.
.. code:: c
$PRERST$INCLUDE$include/list.h(1-17,indent=3)
* lookup3.c was created by Bob Jenkins on May 2006 and released to the Public Domain;
.. code:: c
$PRERST$INCLUDE$src/lookup3.c(1-8,34,indent=3)
.. _`Mastering Algorithms with C`: http://shop.oreilly.com/product/9781565924536.do
Todo
*****
* lcov + badge;
* keep on collecting/documenting/testing libraries;
$PRERST$EXCLUDE$ improve automatic versioning (inc. updating docs etc) when committing