Skip to content
Nathan Paul edited this page Jul 1, 2024 · 5 revisions

Toolchain and Environment

Read the wiki, try out the commands and if you are stuck, use the discussions tab to ask for help.

Prerequisites

We prefer having a live GNU/Linux based or MacOS based environment as this project aims to become a POSIX compliant shell.

Linux/MacOS

Ensure you have the following installed:

  • Git
  • GCC
  • CMake

Install them using your package manager via the terminal:

  • Ubuntu/PopOS: sudo apt-get install git gcc cmake
  • Arch: sudo pacman -S git gcc cmake
  • MacOS: brew install git gcc cmake

Windows

  1. Install WSL by running the following command in PowerShell or Command Prompt as administrator:

    wsl --install
  2. After setup, install Git, GCC, and other prerequisites.

Go ahead with the defaults; set up a username and type a password, and install git and the other prerequisites mentioned above.

Git

Getting familiar with git is essential. We assume you have used GitHub before to store and track your codebase.

Ask for someone to invite you to the GitHub org so you have push access and can start contributing.

Clone our repository using the following URL:

git clone [email protected]:psh-shell/psh.git

C, GCC, and Makefiles

Install gcc in a similar way and run the following to see your project get built.

cd psh
make run
Clone this wiki locally