Contributing¶
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
Where to start?¶
If you are looking for a good issue to start with, please check the following:
- good first issue - issues that should be pretty simple to implement,
- help wanted - issues that typically are a bit more involved than beginner issues,
- high priority - things to fix ASAP but often of higher complexity.
Source¶
To build from source on your local machine, please follow the instructions below:
Clone the repository¶
Install the package manager (conan)¶
The dependencies needed for the development of Endstone are provided Conan Package Manager (>=2.0
). The install
the package manager, run the following commands in your Python environment.
Install dependencies¶
First of all, run the following commands to install dependencies of this project:
Now, activate the build virtual environment create by conan.
Run cmake
and check the version:
Build with CMake¶
Install¶
To install Endstone from your local sources, simply run:
Documentation¶
We are building our documentation using Material for MkDocs.
The easiest way to install all the required dependencies is with pip
:
After that, you can either: