Skip to content

Toolchain

Nathan Paul edited this page Jul 2, 2024 · 4 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
  • Make

Install them using your package manager via the terminal:

  • Ubuntu: sudo apt-get install git gcc make
  • Arch: sudo pacman -S git gcc make
  • MacOS: brew install git gcc make

Windows

The Windows Subsystem for Linux --- lets you easily access an Ubuntu environment without dual booting or spinning up a virtual machine.

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

    wsl --install
  2. Go ahead with the defaults (Ubuntu). Set up a username and type a password (you won't see any text while you're at it). Then install git and the other prerequisites mentioned above for Ubuntu.

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

cd psh
make run

If everything goes well, you'll see this!

gcc -c -o bin/main.o src/main.c
gcc -o bin/psh bin/main.o
./bin/psh
Welcome to psh!

Proceed to chapter 2: How to Work

Clone this wiki locally