Skip to content

Commit

Permalink
README: add a basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dcbaker committed Feb 28, 2024
1 parent e9c1eda commit fba1861
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# CPS-Config

CPS-Config has been designed to be used a drop-in replacement for pkg-config,
with at least some features from pkgconf, as well as it's own features.

## Building

You will need at least a C++ compiler, the Meson build system, and Ninja. It is
currently only tested on Linux.

Basic instructions are:
```sh
meson setup builddir
ninja -C builddir test
```

## Status

CPS-config is currently in alpha status. Some things work, others do not.

Bug reports and other issues are welcome.

Bug fix and feature PRs are welcome. For larger features please open an issue to
help coordinate work.

0 comments on commit fba1861

Please sign in to comment.