Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DvvCz committed Apr 21, 2024
1 parent aa0976f commit 7691644
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,37 @@

> A dead simple C package manager.
This is essentially an all-in-one wrapper for gcc, clang, doxygen, clang-format, etc.
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.

Inspired by the convenience of `cargo` and `bun`.
Inspired by the convenience of modern tools like `cargo` and `bun`.

## Usage

```
cpkg new hello_world
cd hello_world
```bash
cpkg init
cpkg run
```

## Features
- [x] `new`
- [x] `init`
- [x] `build`
- [x] `run`
- [x] `test`
- [x] `doc` w/ Doxygen
- [x] `repl`
- [x] `format`
- [x] `add`
- [x] `install`

### 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 run tests located in `/src/*.test.c` and `/tests/*.c` with `cpkg test`.

### 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

`cpkg` supports other functionalities:

* Formatting using [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html)
* Documenting using [`doxygen`](https://www.doxygen.nl)

## Installation

Expand Down

0 comments on commit 7691644

Please sign in to comment.