Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
notchyves authored Aug 3, 2024
1 parent 9c07c53 commit 7622ed0
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,15 @@
</div>
<br/>

## ⚒️ 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.
Expand All @@ -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).

0 comments on commit 7622ed0

Please sign in to comment.