Skip to content
This repository was archived by the owner on Dec 8, 2025. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (59 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

87 lines (59 loc) · 3.08 KB

CONTRIBUTING

Fixed folders

Except for the following folders, these unlisted folders should not be changed, under any circumstances, because these are created by GNU, and should be stored in there as the rest-overs.

  • .github - Containing  GitHub-related files and actions.
  • .gnu-windows - Including sources and build instructions. May can change to compatible with the installation
  • .gitattributes, .gitignore, *.md, and LICENSE are all generated by GitHub Actions workflows or manually written.
  • .gitmodules contains all settings of Git submodules.

Changes in repo layout and updating versions and tools

Most packages are user-prepared at runtime, using prepare_env.sh.

To update any new packages, please update the versioning in there

Building the repo

Building GNU Windows

Since this repo is a submodule package distribution, it is recommended to update submodules before actual compiling.

git clone https://github.com/tfslabs/gnu-windows.git

Building within Docker (recommended)

Since version 1.1.1, it is recommended to switch to build using Ubunu Dev Containers.

Depends on your host machine architecture and workload limitation, please choose your image that fit with your task.

Replace <your path> with your real path to the local repo. Double-quote is needed if there are spaces in your path.

docker run -it -v <your path>:/root theflightsims/gnu-windows-build:latest bash

Once you're in the bash, try this command:

# Prepare environment
/root/.gnu-windows/prepare_env.sh

# Start building
/root/.gnu-windows/build.sh

Note:

If you have failed to build, it is recommended for you to start from the beginning. In that case, you can use this command

/root/.gnu-windows/cleanup_all.sh

Once it's done, you'll see your GNU application is building in folder .gnu-windows\bootstrap

Building within bare metal environment (non-Docker environment)

Depending on your distro, it is required for your OS installation to have those packages:

Replace <your path> with your real path to the local repo. Double-quote is needed if there are spaces in your path.

# Prepare environment
<your path>/.gnu-windows/prepare_env.sh

# Start building
<your path>/.gnu-windows/build.sh

Note:

If you have failed to build, it is recommended for you to start from the beginning. In that case, you can use this command

<your path>/.gnu-windows/cleanup_all.sh

Once it's done, you'll see your GNU application is building in folder .gnu-windows\bootstrap