README: improvements, community links

This commit is contained in:
Emma Tebibyte 2024-08-12 17:53:43 -06:00
parent cd875df547
commit d2f8fb8106
Signed by: emma
GPG Key ID: 06FA419A1698C270

40
README
View File

@ -1,30 +1,28 @@
“Seek not to walk the path of the masters; seek what they sought.” “Seek not to walk the path of the masters; seek what they sought.”
Matsuo Basho Matsuo Basho
The Bonsai harakit is an alternative to the standard POSIX utility set that Bonsais Harakit is an alternative to the standard POSIX utilities that aims to
aims to be simpler, easier, and more powerful than its counterpart. These tools be simpler, easier, and more powerful. These tools are the result of careful
are the result of careful examination of the current state of POSIX and common examination of the current state common Unix utilities, POSIX-compliant and
Unix utilities. They represent a vision of accomplishing everyday use cases otherwise, following frustrations with design decisions and implementation
with tools that follow the Unix philosophy of “do one thing and do it well”, details. They represent a vision of accomplishing everyday use cases with tools
without clinging to the past. 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 The intent of Harakit is not to conform to or extend POSIX, like the GNU or BSD
their flaws. This project originated from frustrations with the way certain utilities do, but to invent new utilities to perform the same tasks in more
tools work and how other projects that extend POSIX dont 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
intuitive ways. GNU and BSD extensions are convenient but often unhealthy, intuitive ways. GNU and BSD extensions are convenient but often unhealthy,
forgetting the purposes of the tools they extend, or building into existing 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 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 anywhere. Other utility sets aim to provide a number of fully-featured
programs to be used individually, harakit tools are meant to be easily programs to be used individually, Harakit utilities are meant to be easily
composable and work together in pipelines. composable and work together in pipelines.
See docs/ for more on the specific utilities currently implemented. See docs/ for more on the specific utilities currently implemented.
Building Building
========
Harakit utilities require a POSIX-compliant environment to compile, including a 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 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 $ make clean
Contributing
============
See the CONTRIBUTING file for contribution guidelines.
Community
=========
xmpp://bonsai@covenant.murderu.us
irc://feeling.murderu.us/#bonsai
Read More Read More
=========
An Introduction to the Unix Shell An Introduction to the Unix Shell
<https://porkmail.org/era/unix/shell> <https://porkmail.org/era/unix/shell>