From 7622ed0d0e5caf06226c8ea66c74202722f42441 Mon Sep 17 00:00:00 2001 From: chyves <82107846+notchyves@users.noreply.github.com> Date: Sat, 3 Aug 2024 19:41:06 -0400 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6123673..20a4222 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,15 @@
-## ⚒️ Build -To build this project, on the **native branch**, for Windows 10/11 or Linux, you will need to compile this project using CMake. +## ⚒️ Get Started +To get started, you need to have these system requirements: + - Windows 10 version and above + - Ubuntu or Debian + - ...or really, most operating systems with a working C++ compiler :D -Or you can grab an executable from our [releases tab](https://github.com/BeforeTheBloat/bds-btb/releases), and run it from there. +If you just want to get started immediately you can grab an executable from our [releases tab](https://github.com/BeforeTheBloat/bds-btb/releases), and run it from there. + +**However if you want to build this project, you will need to compile the code from the native branch, for Windows 10/11 or Linux using CMake.** ### Instructions building on Windows (MSVC) We use CMake for our projects, but to compile on Windows, MSVC is required to be installed. Mostly MSVC, comes with C++ on Visual Studio, but there are other ways to get MSVC on your device. @@ -31,3 +36,21 @@ cmake . -Bbin && cmake --build bin && "./bin/bds_btb" - [x] MSVC - [x] GCC - [x] Clang + +## 🌟 Features +- **Native cross-platform support:** We make it our top priority for Windows and Linux to run well without need of an emulator. +- **High-level Performance:** Fast performance on our app (it's a console program), and is built on C++ which is one of the fastest languages used today. +- **Full of Features:** Every vanilla feature that you would normally be provided with in vanilla Minecraft Bedrock Edition v1.1.x. +- **Super-easy Lua API:** Easy-to-learn Lua API for you to use to make custom plugins and scripts. + +## 🎉 Contributing +We openly welcome contributions to this project. If you'd like to contribute, you can do this in a few ways: + +### Issue Tracker +If you encounter any issues while using this software, please open an [issue](https://github.com/BeforeTheBloat/bds-btb/issues). Please make sure you have an amazing description and exactly how to recreate this bug. + +### Submitting a Pull Request +We :heart: code contributions, and if you have in any way improved our codebase or added a new feature feel free to open a pull request at any time :D + +## ⚖️ License +bds-btb is licensed with the [Apache License 2.0](https://github.com/BeforeTheBloat/bds-btb/blob/native/LICENSE).