Skip to content

Commit

Permalink
Bump version, improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DvvCz committed Apr 21, 2024
1 parent 7691644 commit 4ffde5f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
Expand Down
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# cpkg

<h1 align="center"> cpkg </h1>

<div align="center">
<a href="https://github.com/DvvCz/cpkg/actions">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/DvvCz/cpkg/nightly.yml?label=nightly">
</a>
<a href="https://crates.io/crates/cpkg">
<img alt="Crates.io Version" src="https://img.shields.io/crates/v/cpkg">
</a>
<a href="https://github.com/DvvCz/cpkg/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/DvvCz/cpkg">
</a>
</div>

> 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`.

Expand All @@ -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 <name> --path /path/to/dependency` and git dependencies with `cpkg add <name> --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.

Expand All @@ -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.

0 comments on commit 4ffde5f

Please sign in to comment.