helios

A collection of tools for 42 curcus.

Prerequisites

• Ensure that bash is available in the system, as it is a bash script.
• Ensure that norminette is installed beforehand.

Installation

Clone the repository.

cd ~
git clone https://github.com/quantumxt/helios.git

Script

The installation script would be used to install the tools.

If you are using zsh as you default shell, uncomment the export to .zshrc instead. (Defaults to .bashrc)

# echo "export PATH=$PATH:/home/username/bin" >> ~/.bashrc
# . ~/.bashrc
echo "export PATH=$PATH:/home/username/bin" >> ~/.zshrc
. ~/.zshrc

Update the script permission with +x, then run the installation script.

sudo chmod +x install.sh
./install.sh

Tools

normcheck

Renamed from checknorm.

   _  ______  ___  __  ___  _______           __  
  / |/ / __ \/ _ \/  |/  / / ___/ /  ___ ____/ /__
 /    / /_/ / , _/ /|_/ / / /__/ _ \/ -_) __/  '_/
/_/|_/\____/_/|_/_/  /_/  \___/_//_/\__/\__/_/\_\ 

Summarises norminette check, and performs additional action(s) if specified.

normcheck [options]

Options:

• -s: Show source code of the file checked.
• -m: Build with make (experimental), run make after it passes norminette check. (Ensure that Makefile is present)
• -h: Help, display more options that could be used.

get_cfiles

Useful for getting the source files that would be used in the Makefile.

Concats all the *.c files within the current directory into an output file (cfile_list.txt).

get_cfiles

Removal

To remove the tools, run the uninstall script.

sudo chmod +x uninstall_tools.sh
./uninstall_tools.sh