Files

37 lines
1.9 KiB
Markdown

<img style="width:100%;" src="/banner.png">
[![Build Pipeline](https://github.com/likle/cwalk/actions/workflows/build-linux.yml/badge.svg)](https://github.com/likle/cwalk/actions/workflows/build-linux.yml)
[![Build Pipeline](https://github.com/likle/cwalk/actions/workflows/build-freebsd.yml/badge.svg)](https://github.com/likle/cwalk/actions/workflows/build-freebsd.yml)
[![Build Pipeline](https://github.com/likle/cwalk/actions/workflows/build-macos.yml/badge.svg)](https://github.com/likle/cwalk/actions/workflows/build-macos.yml)
[![Build Pipeline](https://github.com/likle/cwalk/actions/workflows/build-win.yml/badge.svg)](https://github.com/likle/cwalk/actions/workflows/build-win.yml)
[![codecov](https://img.shields.io/codecov/c/github/likle/cwalk/master.svg?label=Coverage)](https://codecov.io/gh/likle/cwalk)
# libcwalk - path library for C/C++
This is a lighweight C path manipulation library. It is currently compiled and
tested under **Linux**, **FreeBSD**, **Windows** and **MacOS**. It supports UNIX and Windows
path styles on all platforms.
## Features
Please have a look at the
**[reference](https://likle.github.io/cwalk/reference/)** for detailed
information. Some features this library includes:
* **cross-platform** on Linux, FreeBSD, Windows and MacOS
* **simple interface** - just one header
* **combine paths** together
* **basename, dirname and extension** parsing
* **normalize and cleanup** paths
* **resolve and generate relative** paths
* **iterate segments** of the path
* **and more** things...
## Building
**[Building](https://likle.github.io/cwalk/build.html)**,
**[embedding](https://likle.github.io/cwalk/embed.html)** and
**[testing](https://likle.github.io/cwalk/build.html)** instructions are
available in the documentation (it's very easy).
## Docs
All the documentation is available in the
**[the github page](https://likle.github.io/cwalk/)** of this repository.