Betterls is ls, but better. ✨
Betterls is largely inspired by colorls (written in ruby 💎). betterls is entirely written in C and C++, in as bare metal code as possible. development is platform driven and Yes, yes it does work on Windows. betterls takes GNU coreutil ls and supercharges 🦸 it, giving it configurable colored output, and configurable icons via a nerdfont.
TODO: add image here
TODO: Blather on about your application here.
As of right now there is no official installation method. It is highly discouraged to compile the binary and name it ls (or ls.exe). If there is anything wrong with the build you have potential to break your system (oops). The recommended installation method, FOR NOW, is to clone the repository
git clone https://github.com/mark-gutenberger/betterls.gitbuild it
cd betterls
mkdir build -p
cmake ..
cmake --build .TODOTo get started with development, here are some basic requirements for a suitable development environment
| Requirement: | *nix | OSX | Windows |
|---|---|---|---|
| CMake | version 3.15 or later | version 3.15 or later | version 3.15 or later |
| >=c++17 compatible compiler (hopefully you have this if you have CMake...) | clang++ v4 or later or g++ v8 or later | clang++ v4 or later or g++ v8 or later | MSYS2/MinGW with g++ >v8 or clang++ >v4 toolchain or MSVC 19.15 or later (in practice you can use WSL, but this is a native driven tool... so...) |
| trunk.io linter/formatter | (installed in repo) | (installed in repo) | You will need WSL2 for this (yay) |
Aside from you favorite code editor, that's all you should need.
Betterls is fully licensed under the GNU GPLv3.0 license (2022). Please refer to LICENSE.md for more information about licensing.