https://github.com/evanwporter/muuk
muuk - acronym for `Yet Another Unnecessary C++ Build System`
https://github.com/evanwporter/muuk
Last synced: about 1 month ago
JSON representation
muuk - acronym for `Yet Another Unnecessary C++ Build System`
- Host: GitHub
- URL: https://github.com/evanwporter/muuk
- Owner: evanwporter
- License: mit
- Created: 2025-02-04T06:55:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T03:54:17.000Z (about 2 months ago)
- Last Synced: 2025-02-27T04:33:33.694Z (about 2 months ago)
- Language: C++
- Homepage:
- Size: 1010 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# muuk
I don't understand how to use cmake and I liked cargo a lot, so I created my own cargo-like build system.
Another relevant comic:
## Features
- Task runner using `muuk run `. Works pretty much like `npm run <script>`
- Clean command
- C++ Meta builder built on top of Ninja
- C++20 Experimental Module Support
- Rar brute force Cracker
- Able to define Platform, Compiler & Profile Specific Flags
- All flags are automatically applied to dependencies
# guide
## **Basic Structure**
A typical `muuk.toml` file consists of the following sections:
```toml
[package]
name = "my_project"
version = "1.0.0"
[library.my_project]
include = ["include"]
sources = ["src/main.cpp", "src/utils.cpp"]
cflags = ["-Wall", "-Wextra"]
dependencies = { boost = { version = "1.75.0", muuk_path = "../boost" } }
[build.my_executable]
profiles = ["release", "debug"]
sources = ["src/main.cpp"]
dependencies = { "my_library" = { version = "X.Y.Z" } }
[profile.debug]
cflags = ["-g", "-O0"]
lflags = []
[profile.release]
cflags = ["-O2"]
lflags = []
[platform.windows]
cflags = ["-DWIN32"]
lflags = ["-lkernel32"]
[platform.linux]
cflags = ["-DLINUX"]
lflags = ["-pthread"]
[compiler.gcc]
cflags = ["-std=c++20"]
lflags = ["-lstdc++"]
[scripts]
run = "build/debug/my_executable"
```
---
## **1. `[package]`**
This section defines the package's **metadata** (name and version).
```toml
[package]
name = "my_project"
version = "1.0.0"
```
- `name` → The name of the project.
- `version` → The project version.
---
## **2. `[library]`**
The `[library]` section defines **libraries** that can be compiled separately and linked into other targets.
### Example:
```toml
[library]
[library.my_project]
include = ["include"]
sources = ["src/library.cpp"]
cflags = ["-Wall", "-Wextra"]
dependencies = { boost = { version = "1.75.0", muuk_path = "../boost" } }
```
### **Library Keys**
- `include` → A list of include directories.
- `sources` → A list of source files for the library.
- `cflags` → Compiler flags specific to this library.
- `dependencies` → Defines dependencies required by this library.
**Dependency Format:**
```toml
dependencies = { dep_name = { version = "X.Y.Z", git = "https://example.com/author/repo.git", muuk_path = "path/to/dep" } }
```
## **3. `[build]`**
This section defines **build targets**, which can be executables or other build artifacts.
### Example:
```toml
[build.my_executable]
profiles = ["release", "debug"]
sources = ["src/main.cpp"]
dependencies = ["my_library"]
```
### **Build Target Keys**
- `sources` → Source files used to build the target.
- `dependencies` → Libraries this build target depends on.
Note that this build artifact will include the compiler specific rules.
## **4. `[profile]`**
Profiles define **build configurations**, such as `debug` and `release`, but they can be whatever.
### Example:
```toml
[profile.base]
cflags = ["-std:20"]
[profile.debug]
inherits = ["base"]
cflags = ["-g", "-O0"]
lflags = []
[profile.release]
inherits = "base"
cflags = ["-O2"]
lflags = []
```
### **Profile Keys**
- `cflags` → Compiler flags for the profile.
- `lflags` → Linker flags for the profile.
## **5. `[platform]`**
The `[platform]` section defines platform-specific flags. Acceptable platforms are `windows`, `linux`, `apple`.
### Example:
```toml
[platform.windows]
cflags = ["-DWIN32"]
lflags = ["-lkernel32"]
[platform.linux]
cflags = ["-DLINUX"]
lflags = ["-pthread"]
```
### **Platform Keys**
- `cflags` → Compiler flags for this platform.
- `lflags` → Linker flags for this platform.
## **6. `[compiler]`**
This section defines compiler-specific flags. Acceptable compilers are `gcc`, `msvc` or `clang`
### Example:
```toml
[compiler.g++]
cflags = ["-std=c++20"]
lflags = ["-lstdc++"]
```
### **Compiler Keys**
- `cflags` → Compiler flags specific to this compiler.
- `lflags` → Linker flags specific to this compiler.
## **7. `[scripts]`**
This section defines build-related scripts, such as running an executable. This works like `npm run <script>`. Also muuk will add the name of your built executable so you can easily run it.
### Example:
```toml
[scripts]
do = "something.exe"
```
- `run` → Defines how to run the built executable.