From 4ffde5fb7f3871e123bdfb727f546f12fa7f70a1 Mon Sep 17 00:00:00 2001 From: DvvCz <86097860+DvvCz@users.noreply.github.com> Date: Sat, 20 Apr 2024 20:41:03 -0700 Subject: [PATCH] Bump version, improve readme --- Cargo.toml | 2 +- README.md | 44 +++++++++++++++++++++++++++++++------------- 2 files changed, 32 insertions(+), 14 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index c3b5540..db1ff59 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "cpkg" description = "A dead simple C package manager." -version = "0.9.0" +version = "0.9.1" edition = "2021" authors = ["David Cruz "] diff --git a/README.md b/README.md index 703da4e..d7f8251 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ -# cpkg - +

cpkg

+ +
+ + GitHub Actions Workflow Status + + + Crates.io Version + + + GitHub Release + +
> A dead simple C package manager. -This is essentially an all-in-one wrapper for gcc, clang, doxygen, clang-format, etc. - -`cpkg` automatically detects which are present on your system, allowing you to use them with one simple cli. +This is an all-in-one wrapper for `gcc`, `clang`, `doxygen`, `clang-format`, etc. +It automatically detects which are present on your system, allowing you to use them with one simple cli. Inspired by the convenience of modern tools like `cargo` and `bun`. @@ -18,30 +28,38 @@ cpkg run ## Features -### Project Runner +### 🧑‍💻 Project Runner -You can create a project with `new` or `init`, and then run `/src/main.c` with `cpkg run` or `cpkg build` +You can create a project with `new` or `init`, and then run `/src/main.c` with `cpkg run` or `cpkg build`. You can run tests located in `/src/*.test.c` and `/tests/*.c` with `cpkg test`. -### Package Management +### 📦 Package Management You can add local paths with `cpkg add --path /path/to/dependency` and git dependencies with `cpkg add --git https://github.com/nothings/stb/tree/master`. -### Other Components +### 🗄️ Project File Generation + +Project files can be generated using `cpkg generate`. + +This creates a project file that acts as if you ran `cpkg build`, without `cpkg`. + +*Currently only supports basic [`Makefile`](https://www.gnu.org/software/make) generation* + +### 🛠️ Other Components `cpkg` supports other functionalities: * Formatting using [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) * Documenting using [`doxygen`](https://www.doxygen.nl) -## Installation +## ⏬ Installation -### Releases +### 📩 Releases You can download the `cpkg` binary from [the releases](https://github.com/DvvCz/cpkg/releases) (or a nightly build from [actions](https://github.com/DvvCz/cpkg/actions)) -### Cargo +### 📦 Cargo If you have `cargo` you can install from crates.io. @@ -56,6 +74,6 @@ git clone https://github.com/DvvCz/cpkg cargo install --path cpkg ``` -### Upgrading +### 🔄 Upgrading You can easily upgrade your `cpkg` binary using the `cpkg upgrade` command. \ No newline at end of file