C-shell

A shell written in C. For educational purposes.

Attention

Warranty NOT included. Use at your own risk.

Setting up your workspace

This project has a .editorconfig file to enforce project level coding standards.
CLion has built-in support, VSCode requires a plugin.

How to run

Important

Requires a POSIX compliant system.

This project requires CMake to build. Your IDE (VSCode or CLion) should automatically detect the CMakeLists.txt file and build the project. Install extensions for CMake support if prompted.
If you are using the command line, you can run the following commands:

cmake -B build
cmake --build build --config Debug
./build/executable

Generating Documentation

This project uses Doxygen to generate documentation.
If Doxygen is available on your system,
You can generate the documentation by running the following command:

doxygen Doxyfile

The generated documentation can be viewed at /docs.

This repository also has an automated workflow to generate documentatation via Github Actions.