Capy64/README.md

41 lines
1.4 KiB
Markdown

<a href="https://capy64.alexdevs.me">
<img src="https://raw.githubusercontent.com/Ale32bit/Capy64-docs/main/docs/assets/logo.png" alt="Capy64 Logo" title="Capy64" align="right" height="60" />
</a>
# Capy64
[![.NET](https://github.com/Ale32bit/Capy64/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Ale32bit/Capy64/actions/workflows/dotnet.yml)
[![License](https://img.shields.io/github/license/Ale32bit/Capy64)](https://github.com/Ale32bit/Capy64/blob/main/LICENSE)
[![Release](https://img.shields.io/github/v/release/Ale32bit/Capy64?include_prereleases)](https://github.com/Ale32bit/Capy64/releases)
## About Capy64
Capy64 is a fantasy console that runs sandbox Lua 5.4.
Create anything, from Hello Worlds to games!
### CapyOS
CapyOS is the default operating system installed automatically on first run.
The repository for CapyOS can be found here https://github.com/Ale32bit/CapyOS
## Requirements
* [.NET 7 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
## 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/Ale32bit/Capy64.git`.
2. Open the file Capy64.sln with the .NET IDE.
3. Build project