diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c92125e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Side** +- [ ] Lua side +- [ ] C# side +- [ ] Other +- [ ] I don't know + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..914dee8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Side** +- [ ] Lua side +- [ ] C# side +- [ ] Other +- [ ] I don't know + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. 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