Skip to content
*A* set of *C* functions in a Git *R*epository
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
include/ACR
src/ACR
vs2017
.gitignore
LICENSE
README.md

README.md

The ACR Library in C

Get ready, get set, ...

Quick start!

Project Settings

  • Add "ACR/include" to your include paths
  • Add "ACR/src/public.c" to your project

Code

  • Add #include "ACR/public.h" to the top of your C file
  • Call the ACR_Test() function as follows:
if(ACR_Test() == ACR_SUCCESS)
{
    // OK, ACR library is ready for use
}

Slower start...

What is ACR?

A set of C functions in a git Repository

Mission

To create a C library that makes easy things easier and hard things faster for beginners and experts alike.

Goals

  • Great for beginners and experts
  • Portable without trying
  • Avoids dependencies whenever possible
  • Explains everything in great detail; Documented to excess
  • Learn what you never knew; Refresh what you always forget
  • Fast when it needs to be; Safe when it doesn't
  • Use only what you want; Leave the rest behind
  • Object-oriented
  • Zero unexplained warnings

Examples

The fastest way to learn how to use the features provided by this library is to look at the example projects.

For example:

  • Open the source file /example/test_varbuffer/test_varbuffer.c
  • Find the main() function
  • The functions called by main() are ordered from simple to advanced. In this case, StackTest() is the first function called so it is the most simple function in the test_varbuffer.c example

Note: All of the functions in each example are completely self-contained and can be copied into your own project with ease (just don't forget to also grab the #include header(s) from the top of the example file)

Structure

path notes
ACR/ contains the entire ACR library code, examples, and projects
ACR/example contains example code for each feature of this library
ACR/include contains all of the .h header files
ACR/src contains all of the .c source files
ACR/vs2017 contains a Visual Studio 2017 solution and projects for the library and each example

Features

  • Commonly defined values
    • main() function return codes
    • boolean and pointer values
    • common result codes
    • common math values and functions like PI and Circumference
    • common time values like seconds per day
  • Endianess
    • automatic detection
    • byte order swapping
  • 64bit memory
    • standardized types
    • max values
  • Gregorian calendar
    • days of the week
    • months of year
    • real-time clock support via <time.h>
  • Memory buffer and variable length buffer
  • Floating point comparisons
  • Basic UTF8 string handling and unicode conversion

Acknowledgments

Each file in the library has a place for contributors to add their name. It's really important to me that this library is open to best practices and input from the community. Thank you to everyone who has helped along the way!

You can’t perform that action at this time.