README.md

hamon!

or Hamon SHell aka hsh.

_{波紋 - Ripple}

A homemade shell in C.

Compiled with clang or gcc & linked with mold.

Note

This project is in no way functional yet!

Usage

 ./hsh {args}

Installation

Classic installation through package manager and such, won't be available for a very long time.

So you will have to build it yourself.

Oh you want to know how?

With Just

If you want the easy version, be sure to install just

..and run

just fix_perms
just build

And you'll find it in ./bin

Without Just

Here's where it gets "difficult". It's just a tiny bit more commands.

chmod +x ./scripts/build.sh
./scripts/build.sh -c
./scripts/build.sh -l hsh

et voilà! Now it should be located in ./bin/ aswell.

Contributing

Contribution is simple, make sure you're running an editor that works with C and is using clang for compilation.

Such as:

• neovim
• emacs
• vscode/codium
• jetbrains
• whatever!

Just don't clutter the repo with config files for your editor.

You will also need to either have a shell that supports bash scripts, unless you want to port build.sh for Powershell or Batch, which is ick, but I'll gladly accept a pr for it.

Also, one final thing, make sure you have pre-commit hooks.

Note

Windows people!

Just copy and paste the win_compile_commands.json in build and change it so it fits your path.

Don't forget to rename it to compile_commands.json!

direnv users who don't use nix, i'm sorry :(

Made with ❤️ by tatsoku-org!