Mineplay/Hallocy
1
0
Fork 0
Code Issues Pull requests Projects 1 Releases 2 Packages Wiki Activity Actions

docs(index): added index markdown file as starting file for docs

Browse source
This commit is contained in:
Mineplay 2025-04-19 07:28:33 -05:00
parent e6e433102a
commit c33a9a8bc8
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Docs/Index.md Normal file
View file

@ -0,0 +1,12 @@
# Library documentation
Welcome to the documentation of the **Hallocy C library**!
This documentation is split into several parts:
- [Allocator](Allocator.md)
- [Memory management](MemoryManagement.md)
Use this as a guide for using the library within your existing project.
> For installation and initial setup, please refer to the [README.md](../README.md).

4
README.md
View file

@ -60,4 +60,6 @@ Ensure you have the following installed on your system:
## Using the library
The library file can be found in the `./Build/Release` folder as Hallocy.lib for windows and in `./Build` folder as libHallocy.a for linux. To use the library file you will need to copy the Hallocy folder containing the header files and follow the setup process for a library in the build system you are using.
The library file can be found in the `./Build/Release` folder as Hallocy.lib for windows and in `./Build` folder as libHallocy.a for linux. To use the library file you will need to copy the Hallocy folder containing the header files and follow the setup process for a library in the build system you are using.
For more info about how to use the library see the documentation folder named `Docs`.