add readme

ZtModArchive · Sep 28, 2021 · 8835959 · 8835959
1 parent e851b11
commit 8835959
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+<img src="castor3-github-social-preview.png" alt="Arluq logo"/>
+
+# Castor
+Castor is a simple CLI for building z2f files.
+
+# Commands
+
+* `castor init`
+* `castor build [--zip] [--ztroot]`
+* `castor serve`
+* `castor install`
+* `castor install GitHubAcc/Repository/ReleaseVersion`
+* `castor help`
+* `castor version`
+
+# Installation
+Build the solution via `dotnet build`.
diff --git a/castor3-github-social-preview.png b/castor3-github-social-preview.png
diff --git a/castor3-github-social-preview.svg b/castor3-github-social-preview.svg