diff --git a/README b/README index 02e4c32..0c01d5e 100644 --- a/README +++ b/README @@ -1,30 +1,28 @@ “Seek not to walk the path of the masters; seek what they sought.” – Matsuo Basho -The Bonsai harakit is an alternative to the standard POSIX utility set that -aims to be simpler, easier, and more powerful than its counterpart. These tools -are the result of careful examination of the current state of POSIX and common -Unix utilities. They represent a vision of accomplishing everyday use cases -with tools that follow the Unix philosophy of “do one thing and do it well”, -without clinging to the past. +Bonsai’s Harakit is an alternative to the standard POSIX utilities that aims to +be simpler, easier, and more powerful. These tools are the result of careful +examination of the current state common Unix utilities, POSIX-compliant and +otherwise, following frustrations with design decisions and implementation +details. They represent a vision of accomplishing everyday use cases with tools +that follow the Unix philosophy of “do one thing and do it well” without +clinging to the past. -The era of the original Unix tools has been long and fruitful, but they have -their flaws. This project originated from frustrations with the way certain -tools work and how other projects that extend POSIX don’t make anything better. - -The intent of harakit is not to conform to or extend POSIX, like the GNU or BSD -utilities, but to invent new utilities to perform the same tasks in more +The intent of Harakit is not to conform to or extend POSIX, like the GNU or BSD +utilities do, but to invent new utilities to perform the same tasks in more intuitive ways. GNU and BSD extensions are convenient but often unhealthy, forgetting the purposes of the tools they extend, or building into existing utilities features that would be more useful as their own tools to be used -anywhere. Whereas other utility sets aim to provide a number of fully-featured -programs to be used individually, harakit tools are meant to be easily +anywhere. Other utility sets aim to provide a number of fully-featured +programs to be used individually, Harakit utilities are meant to be easily composable and work together in pipelines. See docs/ for more on the specific utilities currently implemented. Building +======== Harakit utilities require a POSIX-compliant environment to compile, including a C compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust @@ -50,7 +48,21 @@ To remove all build and distributable files: $ make clean +Contributing +============ + +See the CONTRIBUTING file for contribution guidelines. + + +Community +========= + +xmpp://bonsai@covenant.murderu.us +irc://feeling.murderu.us/#bonsai + + Read More +========= An Introduction to the Unix Shell