diff --git a/Docs/Index.md b/Docs/Index.md new file mode 100644 index 0000000..7622610 --- /dev/null +++ b/Docs/Index.md @@ -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). \ No newline at end of file diff --git a/README.md b/README.md index 5e68787..1eb6b9a 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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`. \ No newline at end of file