https://github.com/alyxshang/libcoutils

A small library for C containing some utility functions. :gear: :pick:
https://github.com/alyxshang/libcoutils

c-library c99 clang utility-functions

Last synced: about 1 month ago
JSON representation

A small library for C containing some utility functions. :gear: :pick:

• Host: GitHub
• URL: https://github.com/alyxshang/libcoutils
• Owner: alyxshang
• License: other
• Created: 2024-10-10T15:07:23.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-09T14:05:06.000Z (about 1 month ago)
• Last Synced: 2024-11-09T14:33:02.938Z (about 1 month ago)
• Topics: c-library, c99, clang, utility-functions
• Language: C
• Homepage: https://github.com/alyxshang/libcoutils
• Size: 17.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
# LIBCOUTILS :gear: :pick:

![GitHub CI](https://github.com/alyxshang/libcoutils/actions/workflows/c.yml/badge.svg)

***A small library for C containing some utility functions. :gear: :pick:***

## ABOUT :books:

This repository contains the source code for a small library for the C programming language. This library contains a few useful and versatile utility functions. This library aims to be usable in a cross-platform way.

## USAGE :hammer:

### Compiling and Linking

To use this library in your own C project, please follow these steps:

- 1.) Clone this repository.

- 2.) Run the following command from the root of this repository: `clang -c src/coutils.c -o coutils.a -Wall`.

- 3.) Move the file `src/coutils.h` and the file `coutils.a` to a directory of your choosing.

- 4.) When you compile your C project, make sure to supply each of these two files to Clang as source files.

### API Documentation

To understand how to use the functions this library provides, please refer to the comments and functions in the file `src/coutils.c`.

## CHANGELOG :black_nib:

### Version 0.1.0

- Initial release.

- Upload to GitHub.

## NOTE :scroll:

- *LibCoutils :gear: :pick:* by *Alyx Shang :black_heart:*.

- Licensed under the [FSL v1](https://github.com/alyxshang/fair-software-license).