README: overgrown
This commit is contained in:
		
							parent
							
								
									7b2310f8f4
								
							
						
					
					
						commit
						1ca3dadc99
					
				
							
								
								
									
										58
									
								
								README
									
									
									
									
									
								
							
							
						
						
									
										58
									
								
								README
									
									
									
									
									
								
							@ -1,61 +1,9 @@
 | 
			
		||||
“Seek not to walk the path of the masters; seek what they sought.”
 | 
			
		||||
– Matsuo Basho
 | 
			
		||||
overgrown - trinity's harakit workshop
 | 
			
		||||
 | 
			
		||||
The Bonsai harakit utilities are a replacement for standard POSIX utilities
 | 
			
		||||
which aim to fill its niche while expanding on their capabilities. These new
 | 
			
		||||
tools are the result of the careful examination of the current state of POSIX
 | 
			
		||||
and Unix utilies. The Unix Philosophy of “do one thing and do it well” are their
 | 
			
		||||
core but they avoid 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.
 | 
			
		||||
 | 
			
		||||
This project will not follow in the footsteps of GNU; extensions of POSIX will
 | 
			
		||||
not be found here. GNU extensions are a gateway to the misuse of the shell. The
 | 
			
		||||
harakit utilities will intentionally discourage use of the shell for purposes
 | 
			
		||||
beyond its scope.
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant make(1)
 | 
			
		||||
utility.
 | 
			
		||||
 | 
			
		||||
To build and install:
 | 
			
		||||
simple build, no dependencies except rust
 | 
			
		||||
 | 
			
		||||
# pkg_add rust rust-bindgen
 | 
			
		||||
$ make
 | 
			
		||||
$ make PREFIX="/your/preferred/location" install
 | 
			
		||||
 | 
			
		||||
To build with a different compiler than the default:
 | 
			
		||||
 | 
			
		||||
$ make CC=clang
 | 
			
		||||
$ make RUSTC=gccrs
 | 
			
		||||
 | 
			
		||||
To test the utilities:
 | 
			
		||||
 | 
			
		||||
$ make test
 | 
			
		||||
 | 
			
		||||
To remove all build and distributable files:
 | 
			
		||||
 | 
			
		||||
$ make clean
 | 
			
		||||
 | 
			
		||||
Read More
 | 
			
		||||
 | 
			
		||||
An Introduction to the Unix Shell
 | 
			
		||||
<https://porkmail.org/era/unix/shell>
 | 
			
		||||
 | 
			
		||||
Master Foo and the Ten Thousand Lines
 | 
			
		||||
<http://www.catb.org/~esr/writings/unix-koans/ten-thousand.html>
 | 
			
		||||
 | 
			
		||||
Master Foo Discourses on the Unix-Nature
 | 
			
		||||
<http://www.catb.org/~esr/writings/unix-koans/unix-nature.html>
 | 
			
		||||
 | 
			
		||||
Shell Programming!
 | 
			
		||||
<https://tldp.org/LDP/abs/html/why-shell.html>
 | 
			
		||||
 | 
			
		||||
--
 | 
			
		||||
Copyright © 2023–2024 Emma Tebibyte <emma@tebibyte.media>
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user