Add reference to package manager in readme

finwo · Mar 8, 2024 · 5a8830a · 5a8830a
1 parent bbb1b04
commit 5a8830a
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,22 @@ pfree(fd, first);
 palloc_close(fd);
 ```
 
+Installation
+------------
+
+This library makes use of [dep](https://github.com/finwo/dep) to manage it's
+dependencies and exports.
+
+```sh
+dep add finwo/palloc
+```
+
+Dependencies:
+
+- [finwo/assert](https://github.com/finwo/assert.h)
+- [finwo/canonical-path](https://github.com/finwo/canonical-path.c)
+- [finwo/endian](https://github.com/finwo/endian.h)
+
 API
 ---
 

diff --git a/src/palloc.h b/src/palloc.h
@@ -28,6 +28,22 @@
 /// // Close file descriptor and clear internal cache on it
 /// palloc_close(fd);
 /// ```
+///
+/// Installation
+/// ------------
+///
+/// This library makes use of [dep](https://github.com/finwo/dep) to manage it's
+/// dependencies and exports.
+///
+/// ```sh
+/// dep add finwo/palloc
+/// ```
+///
+/// Dependencies:
+///
+/// - [finwo/assert](https://github.com/finwo/assert.h)
+/// - [finwo/canonical-path](https://github.com/finwo/canonical-path.c)
+/// - [finwo/endian](https://github.com/finwo/endian.h)
 
 #ifdef __cplusplus
 extern "C" {