cafkafk/seidr
cafkafk/seidr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: fix readme

Browse source 
Signed-off-by: Christina Sørensen <christina@cafkafk.com>
This commit is contained in:
Christina Sørensen 2023-08-09 16:36:56 +02:00
parent 658a5c9d8c
commit 0a7e6cf439
Signed by: cafkafk
GPG key ID: CDDC792F655251ED
2 changed files with 47 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
README.md Normal file
View file

@ -0,0 +1,47 @@
<div align="center">
# Seiðr
An experimental Rust GitOps/symlinkfarm orchestrator inspired by GNU Stow.
Highly unstable project, expect each change to be breaking.
[![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)
</div>
[![asciicast](https://asciinema.org/a/TVmnEYR3PK40GtoZnwavun0dP.svg)](https://asciinema.org/a/TVmnEYR3PK40GtoZnwavun0dP)
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 throug a single yaml file, giving it a paradigm that should bring joy to
those that use declarative operating systems and package managers.
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.
That said, we're in 0.Y.Z, *here be dragons* for now (although a little less each
commit).
### Installation
git clone https://github.com/cafkafk/seidr
cd seidr
cargo install --path .
### Configuration
If you want a template, you can copy the file from src/test/config.yaml:
mkdir -p ~/.config/seidr/
cp src/test/config.yaml ~/.config/seidr/config.yaml
You should *seriously* change this file before running any commands.
The configuration format will likely break regularly in versions 0.Y.Z.

36
README.org
View file

@ -1,36 +0,0 @@
#+options: toc:nil
* Seiðr
#+html: <img src="https://img.shields.io/badge/license-GPLv3-blue"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg">
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 throug a single yaml file, giving it a paradigm that should bring joy to
those that use declarative operating systems and package managers.
#+HTML: <a href="https://asciinema.org/a/TVmnEYR3PK40GtoZnwavun0dP" target="_blank"><img src="https://asciinema.org/a/TVmnEYR3PK40GtoZnwavun0dP.svg" /></a>
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.
That said, we're in 0.Y.Z, *here be dragons* for now (although a little less each
commit).
** Installation
#+begin_src sh
$ git clone https://github.com/cafkafk/seidr
$ cd seidr
$ cargo install --path .
#+end_src
** Configuration
If you want a template, you can copy the file from src/test/config.yaml:
#+begin_src sh
$ mkdir -p ~/.config/seidr/
$ cp src/test/config.yaml ~/.config/seidr/config.yaml
#+end_src
You should *seriously* change this file before running any commands.
The configuration format will likely break regularly in versions 0.Y.Z.