Getting Started

Requirements

Communication in English

Our developers hail from all over the globe, and English is the common language we use to collaborate. You don’t need to be fluent, but you should be comfortable enough to understand and communicate ideas effectively.

If you’re reading this, you’re likely good to go!

Familiarity with Git

We use Git as our version control system to manage changes across all projects. It’s a cornerstone of our workflow, so understanding the basics is essential.

If you’re new to Git, take a moment to learn it before diving in. Check out the GitHub Docs for a solid introduction. Focus on concepts like commits, branches, remotes, and pull requests.

A GitHub Account

We host our repositories on GitHub, so you’ll need an account to browse code, fork projects, and submit pull requests. If you don’t have one yet, sign up at GitHub and explore the GitHub Docs to get familiar with the platform.

Running GhostBSD

For the best experience, run the latest stable version of GhostBSD on your development machine. While older versions or FreeBSD might work, the latest GhostBSD ensures compatibility with our tools and libraries.

You can download the latest ISO from the GhostBSD website and install it on a physical machine or a virtual environment.

Technologies We Use

Here’s a quick rundown of the tools and languages you’ll encounter in GhostBSD development.

Programming Languages

GhostBSD projects use a mix of languages depending on the task. You don’t need to master them all—just focus on what’s relevant to your interests.

Python

Most of our user-facing tools—like NetworkMgr, Update Station, and Software Station—are written in Python. It’s easy to learn, quick to develop with, and widely used in our ecosystem.

C

The FreeBSD base system (which GhostBSD builds upon) and many libraries are written in C. It’s a low-level language that requires more effort to work with but delivers excellent performance and deep system access.

Bourne Shell (sh)

Many scripts, including build tools like ghostbsd-build and utilities like xconfig, are written in Bourne shell script. It’s a lightweight way to automate tasks in the FreeBSD ecosystem.

GUI Toolkit and Libraries

Our graphical applications primarily use the GTK3 toolkit. We rely on GNOME libraries like GLib and GObject, often accessed through Python via GObject Introspection.

Configuration Tools

We use dconf for storing system configuration. You can interact with it via the gsettings command-line tool or the graphical dconf-editor.

Install dconf-editor for a visual interface:

sudo pkg install dconf-editor

Setting Up Your Development Environment

Let’s get your machine ready for GhostBSD development.

Install GhostBSD Base System Development Tools

GhostBSD doesn’t come with base system development tools preinstalled. To enable compiling code and ports, install the GhostBSD*-dev packages. These include essential build tools, compilers, and libraries:

sudo pkg install -g 'GhostBSD*-dev'

Create a Development Directory

Organize your work in a dedicated directory. A common spot is your home directory:

mkdir -p ~/projects/ghostbsd

Run cd ~/projects/ghostbsd to jump in and start cloning repos. This keeps your repositories and files tidy.

Development Tools

Code Editors/IDEs

Pick an editor or IDE you like—there’s no wrong choice! Here are some favorites:

  • PyCharm Community Edition: Perfect for Python tools like NetworkMgr with built-in linting and debugging.

    sudo pkg install pycharm-ce

  • Visual Studio Code: Lightweight and extensible, great for general-purpose coding.

    sudo pkg install vscode

  • Sublime Text: Fast and minimalist with great plugin support.

    sudo pkg install linux-sublime-text4

  • Neovim or Vim: Lightweight for shell scripts or terminal fans.

    sudo pkg install neovim

For Python development, PyCharm stands out with built-in linting. If using another editor, set up a Pylint plugin (e.g., via VS Code’s marketplace or Sublime’s Package Control) to catch issues early. Try one that fits your style!

Version Control Tools

We use Git for version control. Beyond the command line, these graphical tools help:

  • gitg: A GTK-based interface to browse Git history.

    sudo pkg install gitg
cd ~/projects/ghostbsd
git clone https://github.com/ghostbsd/ghostbsd-ports.git
cd ghostbsd-ports
gitg

  • Sublime Merge: A sleek Git client, pairs well with Sublime Text.

    sudo pkg install linux-sublime-merge

Clone a repo first (e.g., git clone https://github.com/ghostbsd/ghostbsd-ports.git) to explore with these. Many editors also have Git plugins—check yours!

How to Contribute to GhostBSD

We welcome all contributions! To get started, here’s how to jump in: