add readme

Zt-freak · Zt-freak · commit 8835959e2db9 · 2021-09-28T22:14:28.000+02:00
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
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 1280 640"><defs><style>.cls-1{fill:#fff;}.cls-2,.cls-3,.cls-4,.cls-6{fill:#b9322b;}.cls-2{opacity:0.2;}.cls-3{opacity:0.1;}.cls-5{fill:url(#linear-gradient);}.cls-6{font-size:147.81px;font-family:GalanoGrotesqueAlt-Bold;font-weight:700;}.cls-7{letter-spacing:-0.01em;}.cls-10,.cls-8,.cls-9{font-size:100.21px;}.cls-8{letter-spacing:0em;}.cls-9{letter-spacing:-0.02em;}.cls-10{letter-spacing:0em;}</style><linearGradient id="linear-gradient" x1="541.78" y1="69.8" x2="705.8" y2="472.4" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#b9322b"/><stop offset="0.98" stop-color="#82231e"/></linearGradient></defs><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><rect class="cls-1" width="1280" height="640"/><path class="cls-2" d="M1280,404.74a63.75,63.75,0,0,0-89.41,49.17,81.92,81.92,0,0,0-110.14,20.14,45.06,45.06,0,0,0-73.24,13.33,111.86,111.86,0,0,0-209.07,21.24,44.88,44.88,0,0,0-71.35,11,40.72,40.72,0,0,0-62.42-15.21,82.77,82.77,0,0,0-163.26-11.85,44,44,0,0,0-70.21,34.84,68.3,68.3,0,0,0-87.45-10.1,59,59,0,0,0-109.88,42.85H203.94A91.16,91.16,0,1,0,23.3,542.75a93.1,93.1,0,0,0,.59,10.35,47.22,47.22,0,0,0-17.51,7H0V640H1280Z"/><path class="cls-3" d="M0,404.74a63.75,63.75,0,0,1,89.41,49.17,81.92,81.92,0,0,1,110.14,20.14,45.06,45.06,0,0,1,73.24,13.33,111.86,111.86,0,0,1,209.07,21.24,44.88,44.88,0,0,1,71.35,11,40.72,40.72,0,0,1,62.42-15.21,82.77,82.77,0,0,1,163.26-11.85,44,44,0,0,1,70.21,34.84,68.3,68.3,0,0,1,87.45-10.1,59,59,0,0,1,109.88,42.85h29.63a91.16,91.16,0,1,1,180.64-17.38,93.1,93.1,0,0,1-.59,10.35,47.22,47.22,0,0,1,17.51,7H1280V640H0Z"/><rect class="cls-4" x="393.8" y="390.78" width="47.03" height="16.58"/><rect class="cls-4" x="393.8" y="409.09" width="47.03" height="16.58" transform="translate(834.69 0.06) rotate(90)"/><polygon class="cls-4" points="382.13 407.35 344.57 407.35 344.57 390.78 391.6 390.78 382.13 407.35"/><polyline class="cls-4" points="344.57 440.89 360.22 424.32 393.8 424.32"/><polyline class="cls-4" points="362.98 440.89 391.6 390.78 373.2 390.78 344.57 440.89"/><path class="cls-4" d="M360.65,424.32a16.58,16.58,0,0,0,33.15,0"/><rect class="cls-4" x="354.37" y="424.32" width="22.86" height="16.58"/><path class="cls-4" d="M355.1,444.26v9.13h-2.18v-4.55l-2.38,4.55h-1.39l-2.4-4.58v4.58h-2.18v-9.13h2.21l3.06,5.65,3.07-5.65Z"/><path class="cls-4" d="M357.78,445.45a5,5,0,0,1,6.9,0,4.76,4.76,0,0,1,0,6.76,5,5,0,0,1-6.9,0,4.76,4.76,0,0,1,0-6.76Zm1.58,5.32a2.66,2.66,0,0,0,3.74,0,2.67,2.67,0,0,0,.75-1.93,2.7,2.7,0,0,0-.75-1.95,2.63,2.63,0,0,0-3.74,0,2.69,2.69,0,0,0-.74,1.95A2.66,2.66,0,0,0,359.36,450.77Z"/><path class="cls-4" d="M367.36,444.26H371a5.17,5.17,0,0,1,3.63,1.26,4.67,4.67,0,0,1,0,6.61,5.17,5.17,0,0,1-3.63,1.26h-3.61Zm2.25,7.18h1.28a2.92,2.92,0,0,0,2.05-.71,2.74,2.74,0,0,0,0-3.81,2.92,2.92,0,0,0-2.05-.71h-1.28Z"/><path class="cls-4" d="M389.54,453.39h-2.4l-.64-1.66h-3.84l-.64,1.66h-2.41l3.81-9.13h2.31Zm-3.79-3.6-1.17-3-1.16,3Z"/><path class="cls-4" d="M398.7,453.39H396l-2.75-3.13h-.65v3.13h-2.25v-9.13H395a3.38,3.38,0,0,1,2.38.83,2.76,2.76,0,0,1,.9,2.15,2.83,2.83,0,0,1-.64,1.89,3.11,3.11,0,0,1-1.76,1Zm-6.12-5h2.12a1.45,1.45,0,0,0,1-.3,1,1,0,0,0,.37-.81,1,1,0,0,0-.37-.79,1.45,1.45,0,0,0-1-.3h-2.12Z"/><path class="cls-4" d="M406.38,449.53l2.21.44a4.19,4.19,0,0,1-1.57,2.66,4.86,4.86,0,0,1-3,1,4.77,4.77,0,0,1-3.44-1.37,4.78,4.78,0,0,1,0-6.78,4.74,4.74,0,0,1,3.44-1.38,4.81,4.81,0,0,1,3,.95,4.13,4.13,0,0,1,1.6,2.55l-2.2.52a2.48,2.48,0,0,0-4.23-1.19,2.64,2.64,0,0,0-.76,1.93,2.69,2.69,0,0,0,.76,1.95,2.45,2.45,0,0,0,1.84.78,2.35,2.35,0,0,0,1.53-.51A2.6,2.6,0,0,0,406.38,449.53Z"/><path class="cls-4" d="M418.18,444.26v9.13h-2.24v-3.61H412.1v3.61h-2.25v-9.13h2.25v3.56h3.84v-3.56Z"/><path class="cls-4" d="M422,453.39h-2.25v-9.13H422Z"/><path class="cls-4" d="M432.84,444.26,429,453.39h-2.16l-3.89-9.13h2.48l2.48,6.05,2.5-6.05Z"/><path class="cls-4" d="M440.83,451.45v1.94h-7.11v-9.13h7.07v1.94H436v1.71h4.43v1.83H436v1.71Z"/><path class="cls-5" d="M872.08,371.15a32.78,32.78,0,0,1-6,9.21l-.92,1a259,259,0,0,1-40.29,35.47,254.94,254.94,0,0,1-22.19,14.1,244.26,244.26,0,0,1-23.25,11.46,227.09,227.09,0,0,1-48.39,14.71,209.31,209.31,0,0,1-48.78,3.3,202.79,202.79,0,0,0,80-45.24,201.54,201.54,0,0,0,29-33,202.41,202.41,0,0,0,20.67-37,32.74,32.74,0,0,1,60.11,26Zm-141.8,52.58a203.93,203.93,0,0,1-262.8-11.26A40.81,40.81,0,1,1,527.75,358c55,73.57,119.21,65.94,158.47,50.83-50-18.47-113.23-47.54-104.12-74,14.82-43-35.91-59.85-52.73-84.65s-21.95-69.55-21.95-69.55-14.82-6-17.95-13.11-2-21.09-2-21.09c-17.7-.62-22.33-14.09-22.81-26.48a8.43,8.43,0,0,1,2.74-6.51,203.74,203.74,0,0,1,40.06-29A88.17,88.17,0,0,1,533.64,75l18.79-3.58A69.58,69.58,0,0,1,587,73.64c9.28-2.76,23-4.7,20.93,8.88l26.86,11.94a195.75,195.75,0,0,0,41.11,13.07l28.52,5.7c41.31,8.26,75.93,36.77,91.14,76.05a203.75,203.75,0,0,1-47.61,219h0l-.2.19c-.49.49-1,1-1.5,1.44-.78.74-1.55,1.48-2.34,2.21l-1.67,1.52c-.76.69-1.53,1.37-2.3,2.05-.56.5-1.13,1-1.7,1.48-.8.69-1.61,1.37-2.43,2.05l-1.63,1.35-2.86,2.29c-.36.27-.7.56-1.05.83ZM544.37,96.14c-3.38-1.88-7-3.77-9.71-4.12-6.89-.88-14.14,4.44-18.4,8.32a5.84,5.84,0,0,0,0,8.69c7.87,6.9,20,2,28.25-2.76A5.83,5.83,0,0,0,544.37,96.14Z"/><text class="cls-6" transform="translate(339.44 569.79) scale(1.06 1)">Cas<tspan class="cls-7" x="271.23" y="0">t</tspan><tspan x="333.75" y="0">or</tspan><tspan class="cls-8" x="487.47" y="0">3</tspan><tspan class="cls-9" x="544.79" y="0">.</tspan><tspan class="cls-10" x="567.44" y="0">0</tspan></text></g></g></svg>
