Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 2.4 KB

BUILDING.md

File metadata and controls

61 lines (44 loc) · 2.4 KB
Raw

Building PawLIB

Building Basics

CMake 3.1 or later is used to build PawLIB and PawLIB Tester. For your convenience, we've included Makefiles to automate all common build scenarios on Linux. Run $ make in the root of this repository for more information.

At this time, the Makefiles are only designed for Linux. If you are building on another system, you can interact with CMake directly.

Currently, PawLIB is only designed to be built by GCC (5.3 or later) or Clang (3.4 or later).

Building and Linking Dependencies

PawLIB relies on CPGF. The default behavior of the build system is to look for MousePaw Media' libdeps/ repository, cloned parallel to this repository's main folder. Simply run $ make ready or $ make cpgf in that repository before building this one. (This is our default for company development environments.)

You can specify custom paths for these libraries by creating a .config file in the root of this repository. Make a copy of build.config.txt and save it with the ending .config. See that file for more information.

Ready-To-Use Build

If you just want to build PawLIB to use in your own project, the fastest way is to run $ make ready. This will build PawLIB and place it in a folder called pawlib, then point your compiler and linker to pawlib/include and pawlib/lib respectively. Our other repositories point to this by default.

Building HTML Docs

If you want the HTML documentation for PawLIB, run $ make docs. Then, grab the docs/build/html folder, or just open docs/build/html/index.html in your favorite web browser.

Building Tester

If you want to test out PawLIB directly, run make tester. Then, look for the pawlib-tester executable in pawlib-tester/bin/[Debug/Release]. Alternatively, you may use the symbolic link tester or tester_debug in the root of this repository.

IDE Support

PawLIB was written and built in CodeBlocks and VSCode. The CodeBlocks projects (*.cbp) in this repository are pre-configured to build using the Makefile/CMake build system. The configuration files in .vscode/ are pre-configured to provide the best IDE experience, and allow building and debugging.

Source Directories

  • The /docs/ folder contains the Sphinx documentation for PawLIB.
  • The /pawlib-source/ folder contains the source code for the PawLIB library.
  • The /pawlib-tester/ folder contains the console application for testing the PawLIB library.