added readme

2025-04-19 21:26:14 -04:00 · 2025-04-19 21:26:14 -04:00 · 876c6bc301
commit 876c6bc301
parent 6729de6d93
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,16 @@
+# CaitSith
+
+![actions](https://scm.wyattjmiller.com/wymiller/CaitSith/actions/workflows/build.yml/badge.svg?branch=master)
+
+Copyright 2025, all rights reserved
+
+## Hacking
+
+Requirements:
+
+- Rust (built on 1.86, 2021 edition)
+- git
+- pkg-config
+- openssl-devel
+
+If you are running `nix` or NixOS, you should probably run the provided `flake.nix`