You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
malachite/README.md

49 lines
2.0 KiB
Markdown

<p align="center">
2 years ago
<a href="https://github.com/crystal-linux/Malachite">
<img src="https://github.com/crystal-linux/branding/blob/main/logos/crystal-logo-minimal.png?raw=true" alt="Logo" width="150" height="150">
</a>
</p>
2 years ago
<h2 align="center">Malachite</h2>
2 years ago
<p align="center">
2 years ago
<a href="https://discord.gg/yp4xpZeAgW"><img alt="Discord" src="https://img.shields.io/discord/825473796227858482?color=blue&label=Discord&logo=Discord&logoColor=white"?link=https://discord.gg/yp4xpZeAgW&link=https://discord.gg/yp4xpZeAgW> </a>
<img src="https://img.shields.io/badge/Maintainer-@ihatethefrench-brightgreen" alt=The maintainer of this repository" href="https://github.com/ihatethefrench">
3 years ago
</p>
2 years ago
3 years ago
<p align="center">Malachite is a simple yet useful workspace and local repository management tool, made for packagers of Arch Linux based distributions.</p>
## Basic usage
| Action | Command |
|--------------------------------------------------------|--------------|
3 years ago
| Build a package | mlc build \<package\> |
| Generate local repository | mlc repo-gen |
| Update local repos/PKGBUILDs | mlc pull/update |
| Create and/or open config file | mlc conf |
| Initialises repo/workspace based on config in mlc.toml | mlc init |
| Prunes old duplicate packages from repository | mlc prune |
3 years ago
### Pacman Repository Creation
- `mlc config` to create the config (and also populate it)
- `mlc init` to build repository base from config file
- `mlc build <package>/--all` to either build individual packages or all packages in mlc.toml
- `mlc repo-gen` to generate functional pacman repository at \<name\>/\<name\>.db from built packages
## How to build:
Tested on latest Cargo (1.60.0-nightly)
<br>
#### Debug/development builds
- `cargo build`
#### Optimised/release builds
2 years ago
- `cargo build --release`