Table of Contents

• Table of Contents
  • C Project Skeleton
    • Code Formatting Rules
    • Static Analysis Tools
      • Optional Static Analysis tools
        • Free Options
        • Premium, Paid Options
    • Windows Installation
    • Linux Installation
      • Linux Testing Information
      • Red Hat-based - SonarQube Scanner will have to be downloaded and installed manually for all redhat-based distros
      • Debian-based
      • Arch-based
      • NixOS-based
      • OpenSUSE-based
      • Running the Linux script
    • MacOS Installation
      • Running the MacOS install script
    • If you want to use Sonarqube locally with Sonar Scanner
      • Linux Setup Instructions
      • MacOS Setup Instructions
    • Important SonarQube Note

C Project Skeleton

THIS PROJECT IS A WIP. It needs a lot of work.

This is a basic C project skeleton. This project provides sane and strict CFLAGS for compiling C programs. This project also includes several make targets to run static analysis tools to help with code saftey and code smell.

Code Formatting Rules

This project follows Google's formatting rules for C/C++.

Static Analysis Tools

• cppcheck - The free open source version.
• valgrind
• leaks - MacOS only
• clang-analyze
• clang-tidy
• flawfinder
• sonarqube-scanner - Note: This is not the same thing as sonarqube. It works with sonarqube when you have sonarqube installed.
• infer
• ASAN

Optional Static Analysis tools

Free Options

• sonarqube - requires OpenJDK 17, PostgreSQL, and proper setup. (Free Community Edition. Option to purchase a more premium version.)
  • This is not the same as sonarqube-scanner. This works with sonarqube-scanner when it's installed along side the sonarqube-scanner.
  • This has to be downloaded manually for Fedora.
• coverity - requires registering a free account and following instructions to set it up.

Premium, Paid Options

• cppcheck premium - free trial, requires a purchase
• pvs-studio - free trial, requires a purchase

Windows Installation

For Windows users, it is recommended to use WSL 2 with Ubuntu and run the install_linux.sh script. This will provide a consistent development environment and simplify the setup process.

You can install WSL by following these steps. Open Command Prompt or Powershell in administrator mode and run the following command:

wsl --install

The default distro installed with WSL is Ubuntu. If you don't like Ubuntu, you can see a list of available distros by running the following command:

wsl --list --online or wsl -l -o

You can change the default Linux distro by running the following command:

wsl --install -d <Distribution Name>

Replace <Distribution Name> with the name of a distribution you found when you ran the command to list distributions.

If you choose to change the distro away from Ubuntu in WSL, please read the disclaimer I've added to the Linux Installation section.

Linux Installation

Disclaimer: The only distro I'm testing with WSL in Windows is Ubuntu. If you choose a different distribution in WSL, you'll have to modify the install_linux.sh script should there be any errors or failures during installation. Find the section that matches your chosen distro. Modify the script so that it works with your distribution.

Here's a list of supported Linux distros. They all haven't been tested yet. The distros with a check beside them have been tested. As these distros are tested, I will specify which versions were tested.

Linux Testing Information

I created virtual machines for all the distros below on two machines: one running Pop!_OS 22.04 LTS and on a MacBook Pro M3 with the Apple Silicon chip. I used VirtualBox on Pop!_OS and VMWare Fusion on the MacBook Pro. I installed 64-bit versions of the operating systems. Specifically, x86_64/amd64 on Pop!_OS and aarch64/arm64 on Mac if available. If no aarch64/arm64 versions were available for a specific version of Linux, then that version was not tested on the Mac. I will explicitly list versions tested for each distro. If I didn't list something, then it wasn't tested.

The Ubuntu running in WSL 2 on Windows is the latest x86_64/amd64 architecture version.

I used the following specifications for all VMs:

• 40 GB disk
• 4 GB RAM
• 2 vCPUs
• 128MB Video Memory with 3D Acceleration enabled

Red Hat-based - SonarQube Scanner will have to be downloaded and installed manually for all redhat-based distros

• RHEL
  • RHEL 9.4 64-bit amd64 ✅
  • RHEL 9.4 64-bit aarch64
• CentOS
  • CentOS 9 64-bit amd64
  • CentOS 9 64-bit aarch64
• Fedora
  • Fedora Workstation 40 64-bit amd64 ✅
  • Fedora Workstation 40 64-bit aarch64
• Rocky Linux
  • Rocky Linux v9.4 64-bit amd64
  • Rocky Linux v9.4 64-bit aarch64
• AlmaLinux
  • AlmaLinux 9 64-bit amd64
  • AlmaLinux 9 64-bit aarch64

Debian-based

• Debian
  • Debian 12.5 amd64 ✅
  • Debian 12.5 arm64
• Ubuntu
  • Ubuntu 22.04.4 LTS amd64 ✅
  • Ubuntu 22.04 LTS arm64
  • Ubuntu 24.04 LTS amd64 ✅
  • Ubuntu 24.04 LTS arm64
• Ubuntu in WSL
  • Ubuntu 24.04 LTS amd64
• Linux Mint
  • Linux Mint 20.3 Cinnamon amd64 ❌ - the latest PostgreSQL available here is 12. The installer failed when trying to install PostgreSQL 16. You may be able to find a guide online to install PostgreSQL 16 on this version of Linux Mint. Highly advise going with the latest version instead of this version.
  • Linux Mint 21.3 Cinnamon amd64 ✅ - You'll have to follow this guide to install PostgreSQL 16 on this version of Linux Mint.
• Pop!_OS
  • Pop!_OS 22.04 LTS amd64 ✅
• Kali Linux
• Zorin OS

Arch-based

• Arch Linux
• Manjaro
• Garuda Linux
• ArcoLinux
• EndeavourOS

NixOS-based

• NixOS

OpenSUSE-based

• openSUSE
• SUSE
• SLES
• GeckoLinux

Running the Linux script

Make the installation script executable:

chmod +x ./install_linux.sh

Then run the installation script.

./install_linux.sh

MacOS Installation

Install Xcode and the Xcode commandline tools. Install Xcode through the App Store. You can install the commandline tools with the following cli command:

xcode-select --install

Install Homebrew before running the script. Here's how you can install homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Running the MacOS install script

chmod +x ./install_macos.sh

Then run the script:

./install_linux.sh

If you want to use Sonarqube locally with Sonar Scanner

Be sure to follow these instructions to setup PostgreSQL and SonarQube properly.

Linux Setup Instructions

I'm including instructions for installing PostgreSQL on Ubuntu 24.04 LTS and how to install SonarQube on Ubuntu 22.04 LTS. I couldn't find a document outlining the installation process for SonarQube on Ubuntu 24.04 LTS. However, the process for both should be identical. I used articles from Vultr. You don't have to setup a Vultr server. The instructions can be applied to a local installation of Ubuntu.

Note: A simple Google search will show you how to setup and configure these tools on your distro of choice.

How to install PostgreSQL on Ubuntu 24.04

How to use SonarQube on Ubuntu 22.04 LTS

MacOS Setup Instructions

PostgreSQL 16 Setup Instructions

Setup Sonarqube

Important SonarQube Note

When you update the .envrc file with your SonarQube information, make sure to exclude it from GitHub.

Add .envrc to .gitignore.

echo ".envrc" >> .gitignore

Removed .envrc file from the Git repository:

git rm --cached .envrc

Be sure to commit your changes.

git commit -am "Remove .envrc from the repository"