Contribution Build Setup - HueSamai/CementSource GitHub Wiki

This page covers how to install the Cement source code for both Visual Studio Code and Visual Studio Community and get it to build, so that you can test the changes you've made and push and pull changes to and from GitHub.

Things you'll need to download

Install the .NET Development Framework
Install Git

Visual Studio Code - Download

Start by clicking the download link above to install Visual Studio Code.

Then create a directory anywhere on your PC to house the Cement source code.

If you are on Windows, open the folder and right click and select 'Open in terminal'. Now we need to clone the git repo into the folder with the following command:

git clone https://github.com/HueSamai/CementSource.git .

Then when it is done, to open it in VS code, we run the following command:

code .

In VS Code, you will need to go to the extensions tab (by either clicking on the icon on the left made out of 4 blocks, with one separate, or by clicking on the 'View' menu at the top and selecting 'Extensions'), and then search for and install the 'C#' extension so that your code gets highlighted, and you get autocompletion and code navigation.

To build Cement, go to the 'Terminal' menu, and select 'New Terminal'.

In the newly created terminal, you can build Cement with:

dotnet build

Good luck on your Cement journey!

Visual Studio Community - Download

WARNING: This guide is incomplete. Only attempt to continue if you know how to Google.

  • Start by installing VS Community via the link above.

    • Once installed and inside VS Community, you should be at a welcome page, with buttons somewhere giving you options for creating a new project.
  • Click Clone a Repository.

  • Copy and paste the url https://github.com/HueSamai/CementSource.git into the Repository location text box.

  • Set a path you'd like to contain the source code.

  • Click Create.

    • After a little while it should drop you into the IDE.
⚠️ **GitHub.com Fallback** ⚠️