Initial commit, stdint, added comments
This commit is contained in:
28
README.md
Normal file
28
README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# atom
|
||||
|
||||
## Description
|
||||
Simple string interning library. Interning strings will optimize memory usage and prevent duplicates, allowing for faster comparison and reduced memory overhead. This is useful when you need to store many identical strings (such as identifiers or constants) but want to avoid storing them multiple times.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Features](#features)
|
||||
- [Usage](#usage)
|
||||
- [Credits / Resources](#credits--resources)
|
||||
- [License](#license)
|
||||
|
||||
## Features
|
||||
atom_string(const char *str): Interns a string and returns a pointer to the interned string. It is automatically converted to a string if given an argument of type const char *.<br>
|
||||
atom_int(int64_t n): Converts an integer to its string representation and interns it. Useful for handling numeric strings efficiently.
|
||||
|
||||
## Usage
|
||||
|
||||
## Credits / Resources
|
||||
[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
|
||||
[Make a README](https://www.makeareadme.com/)<br>
|
||||
[Choose a LICENSE](https://choosealicense.com/)<br>
|
||||
[C Interfaces and Implementations](https://github.com/drh/cii)<br>
|
||||
[Glib - Quark](https://docs.gtk.org/glib/alias.Quark.html)<br>
|
||||
|
||||
## License
|
||||
This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in New Issue
Block a user