diff --git a/README.md b/README.md new file mode 100644 index 0000000..b13bf47 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ + + Capy64 Logo + + +# Capy64 + +[![.NET](https://github.com/Capy64/Capy64/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Capy64/Capy64/actions/workflows/dotnet.yml) +[![License](https://img.shields.io/github/license/Capy64/Capy64)](https://github.com/Capy64/Capy64/blob/main/LICENSE) +[![Release](https://img.shields.io/github/v/release/Capy64/Capy64?include_prereleases)](https://github.com/Capy64/Capy64/releases) + +## About Capy64 + +Capy64 is a fantasy console that runs sandbox Lua 5.4. + +Create anything, from Hello Worlds to games! + +## Building + +### Requirements + +* [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) +* .NET IDEs, such as + * [Visual Studio](https://visualstudio.microsoft.com/) + * [Jetbrains Rider](https://www.jetbrains.com/rider/) + * Any other .NET compatible IDE + +### Steps + +1. Clone the repository with `git clone https://github.com/Capy64/Capy64.git`. +2. Open the file Capy64.sln with the .NET IDE. +3. Build project