README.md

libpath

Path parsing library (for C and C++)

Table of Contents

• Introduction
• Installation
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Proper Dependencies
    • Development Dependencies
  • Related projects
  • License

Introduction

libpath is a small, standalone library, implemented in C with a C and a C++ API, that provides file-system path parsing and comparison, for platform-dependent - Unix and Windows - and platform-independent path manipulation. It is intended to be useful for application-level programming as well as a basis for other libraries.

Installation

Detailed instructions - via CMake - are provided in the accompanying INSTALL.md file.

Components

• Comparing API (C and C++);
• Equating API (C and C++);
• Parsing API (C and C++);

Examples

Examples are provided in the examples directory.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/libpath.

If you'd like to help out with the project, please raise an issue via GitHub Page - you'll be very welcome!

Dependencies

Proper Dependencies

libpath has no proper (i.e. runtime / build) dependencies outside the facilities of the C standard library and, for its C++ API, the C++ standard library.

Development Dependencies

In order to run the test programs, libpath has the following development dependencies:

• STLSoft 1.11 or later;
• xTests 0.26 or later;

Related projects

• libpath.Go;
• libpath.Ruby;
• libpath.Rust;
• recls;

License

libpath is released under the 3-clause BSD license. See LICENSE for details.