Skip to content

Toolchain

Nathan Paul edited this page Jul 1, 2024 · 4 revisions

Environment

Here's how to setup your toolchain and get started.

We prefer having a live GNU/Linux based or MacOS based environment.

If you use Linux/MacOS

You probably have all the prerequisites installed, if not install git, gcc and cmake from your package manager. Google how to use apt for Ubuntu/PopOS, pacman for Arch and brew for MacOS. Use the discussions tab to ask for help.

If you use Windows

You can now install everything you need to run WSL with a single command. Open PowerShell or Windows Command Prompt in administrator mode by right-clicking and selecting "Run as administrator", enter the following command and then restart your machine.

wsl --install

Go ahead with the defaults, setup 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 code base.

ref: https://rowjee.com/blog/git_up_and_running

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
Clone this wiki locally