Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added a link to the doxygen deployment
  • Loading branch information
kpluas21 authored May 7, 2023
1 parent a32b84b commit 6f20f95
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Kevin's C Library

My implementation of popular data structures and programs in C.
## How To Use
More information on the programs can be found in their respective folders. Each program was made to be as independent as possible. As a result, simply including the header and source file will be enough to use the module.

## Documentation
If you have doxygen installed you can create some very nice looking documentation using a single command.

To view the most updated documentation, click on this [link](https://kpluas21.github.io/Kevins-C-Library/).

Alternatively, if you have doxygen installed you can your own nice looking documentation using a single command.
From the main directory, simply type
```
doxygen Doxyfile
```
A directory named _docs/_ will be generated and you can open up index.html with any browser to view all documentation created for this library.

## Tools Currently Implemented

* DynamiC : A generic dynamic array
* LinkC : A generic linked list
* BstC : A binary search tree using integers
Expand Down

0 comments on commit 6f20f95

Please sign in to comment.