📘 GitHub Repository Compilation Manual

📖 1. Introduction

This guide helps you understand how to work with open-source projects hosted on GitHub. You'll learn to fork a repository, clone it to your computer, compile the code in various languages, and sync with updates from the original repository.

⚙️ 2. Environment Setup

Debian

Install development tools using APT:

sudo apt update && sudo apt upgrade
sudo apt install build-essential git curl wget cmake ninja-build pkg-config

Windows 11

Recommended installations:

• 🐙 Git: Download here
• 🧱 Visual Studio: Install with C++ and .NET workloads
• 🍫 Chocolatey: Install guide

🔀 3. Forking a Repository

1. Navigate to the GitHub repository you wish to fork.
2. Click the Fork button on the top-right.
3. Select your account or organization to fork into.

📥 4. Cloning Your Fork

Clone the forked repository:

git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME

Add the original repo as upstream:

git remote add upstream https://github.com/ORIGINAL_OWNER/REPO_NAME.git

🛠️ 5. Compiling Code by Language

Go

go build .
go test ./...

Rust

curl https://sh.rustup.rs -sSf | sh
cargo build --release
cargo test

C++ (CMake)

Debian:

mkdir build && cd build
cmake ..
make

Windows:

cmake -S . -B build
cmake --build build --config Release

C# (.NET)

dotnet build
dotnet run

🔄 6. Syncing Fork with Upstream

Update your fork with the original repository:

git fetch upstream
git checkout main
git merge upstream/main
git push origin main

🧰 7. Troubleshooting

• ❓ Command not found: Ensure it's installed and in PATH.
• ⚠️ CMake errors: Check compiler and CMakeLists.txt.
• 📦 Missing deps: Read the README or install guide.
• 🔁 Submodules: Run

  git submodule update --init --recursive

• 🔐 Permissions: Use sudo on Linux or check folder rights.