Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cafkafk committed Oct 27, 2023
1 parent a040463 commit ec46989
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,38 @@ SPDX-FileContributor: Christina Sørensen
SPDX-License-Identifier: AGPL-3.0-only
-->
<div align="center">

# Rust Powerset Generator
<h1>RIME</h1>

> **Warning**
> This program is WIP
![Rimed_hexagonal_snow_crystal TIF](https://github.com/cafkafk/rime/assets/89321978/c6490432-e6d2-430d-8437-b2506c2dae88)

Nix Flake Input Versioning

Powerset is a simple Rust binary (and perhaps future library), that takes a
configuration file specifying commands and uses it to produce a powerset of
those commands. This helps easily generate tests from a single source of truth,
allowing your tests to be initialized at any time from the declarative
configuration.
[![Built with Nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&labelColor=73C3D5)](https://nixos.org)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![Unit tests](https://github.com/cafkafk/seidr/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/cafkafk/seidr/actions/workflows/unit-tests.yml)
![Crates.io](https://img.shields.io/crates/v/seidr?link=https%3A%2F%2Fcrates.io%2Fcrates%2Fseidr)
![Crates.io](https://img.shields.io/crates/l/seidr?link=https%3A%2F%2Fgithub.com%2Fcafkafk%2Fseidr%2Fblob%2Fmain%2FLICENCE)

Historically, it would parse the output of a binary via a regex. Currently,
it's being refactored to generate configurations from this parsing, but
primarily being dependent on the actual configuration first and foremost.
</div>

This program was created for eza, but eventually, it should be usable more
broadly.
> **Warning**
> RIME is experimental. You're warned.
## Usage
A Rust GitOps/symlinkfarm orchestrator inspired by GNU Stow. Useful for dealing
with "dotfiles", and with git support as a first class feature. Configuration is
done through a single yaml file, giving it a paradigm that should bring joy to
those that use declarative operating systems and package managers.

Compile the Rust program:
Although this isn't really a case where it matters *that* much for performance,
being written in rust instead of e.g. /janky/ scripting languages does also mean
it is snappy and reliable, and the /extensive/ (hardly, but eventually) testing
helps ensure regressions aren't introduced.

```bash
cargo build --release
```
That said, we're in 0.Y.Z, *here be dragons* for now (although a little less each
commit).

# Contribution
### Try Out Rime

Feel free to fork this repository, make changes, and submit pull requests. Any contributions, whether it's improving the logic, adding features, or fixing bugs, are always welcome!
nix run github:cafkafk/rime

0 comments on commit ec46989

Please sign in to comment.