heime 0.0.1

A simple dotfile manager using Rust and Lua
<h1 align="center">heime</h1>
<p align="center">
    <a href="https://github.com/sondr3/heime/actions"><img alt="GitHub Actions Status" src="https://github.com/sondr3/heime/workflows/pipeline/badge.svg" /></a>
</p>

<p align="center">
    <b>A small and simple dotfile manager written in Rust using Lua for configuration.</b>
</p>

- **Simple**: Not overly complicated, use the exported functions to move files around.
- **Configurable**: Want different settings between work, different personal
  machines and so on? We do that.
- **Experimental**: This is primarily made for my own personal use so beware of
  fire, missing files and bugs.

<details>
<summary>Table of Contents</summary>
<br />

## Table of Contents

- [Installation]#installation
- [Getting started]#getting-started
- [What the name]#what-the-name
- [License]#license
</details>

# Installation

Clone the repo and do a `cargo install -f --path .`.

# Getting started

N/A. This is currently only a collection of functions and test.

# What the name

The name `heime` is the word for `home` in Nynorsk, one of the two written languages
in Norway. The inspiration should be fairly obvious, it's a program to manage your
home... on your computer(s).

```text
heime        heime n. (norse heima, heimi) heimstad
             eige, ha heime
```

# License

GPLv3.