Skip to content
This repository has been archived by the owner on May 30, 2022. It is now read-only.
/ libpampa Public archive

A library with some algorithms I implemented during my CS @ unipampa.

License

Notifications You must be signed in to change notification settings

oAGoulart/libpampa

Repository files navigation

libpampa

License GitHub release (latest by date) Build Status

A library with some algorithms I implemented during my CS course @ unipampa.

Usage

This library is supposed to be used just by including the files you need in your code, like this:

#include "memory.h"

There are some caveats tho, some headers may require system specific libraries or dependencies (there isn't much I can do about that), here is a list of requirements for each header:

  • memory.h
    • on Windows: Kernel32.lib
  • file.h
    • on Windows: Kernel32.lib (because it uses memory.h)

Make sure to link these libraries when compiling your code, you can do this easily using CMake:

if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
  target_link_libraries(your_exe Kernel32.lib)
endif()

Building examples and tests

To build the examples and tests provided, just use CMake!

mkdir build && cmake ../

Then you should be able to run the executables!

Generating documentation

You can use the documentation on docs/ as reference.

To generate documentation again, use Doxygen (docs/ were generated on Windows x64):

doxygen Doxyfile

Contributions

Feel free to leave your contribution here, I would really appreciate it! Also, if you have any doubts or troubles using this library just contact me or leave an issue.