diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f0a0432 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 runreal + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 1428939..aa89043 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -# runreal cli \ No newline at end of file +# runreal cli + +![hero](assets/hero.png) + +

The Open-Source Unreal Engine toolkit. +
+ Documentation » +
+
+ Website + · + Twitter +

+ +**Unreal Engine** Configure engines, build projects, and run UAT/UBT commands. +**Buildgraph** Generate reports from your buildgraphs. + + +## Installation + +Download the latest release from the [Releases](https://github.com/runreal/cli/releases/latest) page. + + +## Setup + +1. Clone the cli + +```bash +git clone https://github.com/runreal/cli +``` + +2. Install dependencies + +```bash +deno install +``` + +3. Run the cli in dev mode + +```bash +deno task dev +``` + +### Compiling to binaries + +```bash +deno task compile-win +deno task compile-linux +deno task compile-macos +``` + +### Changelog +See the [CHANGELOG](CHANGELOG.md) for a list of changes. + + +### License + +MIT [LICENSE](LICENSE) diff --git a/assets/hero.png b/assets/hero.png new file mode 100644 index 0000000..7c797d8 Binary files /dev/null and b/assets/hero.png differ