Brought back readme
This commit is contained in:
parent
0dd39a5fac
commit
91940218c0
1 changed files with 65 additions and 0 deletions
65
README
65
README
|
@ -0,0 +1,65 @@
|
|||
fenutils - Fenix Core Utilities
|
||||
===============================
|
||||
|
||||
fenutils is a collection of utilities used in Fenix. Many of these utilities
|
||||
are defined by POSIX and are portable across UNIX and UNIX-like systems. Many
|
||||
are also capable of functioning as a drop-in replacement for the version that
|
||||
may be found on such a system.
|
||||
|
||||
Currently, the following tools are completed, working, and POSIX-compliant:
|
||||
|
||||
asa
|
||||
basename
|
||||
cat
|
||||
cksum
|
||||
cmp
|
||||
dirname
|
||||
echo
|
||||
false
|
||||
head
|
||||
link
|
||||
ln
|
||||
pwd
|
||||
true
|
||||
|
||||
The following sh built-ins are completed, working, and POSIX-compliant:
|
||||
|
||||
cd
|
||||
|
||||
The following tools are completed and working, though not necessarily
|
||||
POSIX-compliant:
|
||||
|
||||
tty
|
||||
|
||||
The following tools are working, but not complete or POSIX-compliant:
|
||||
|
||||
cal
|
||||
sh
|
||||
wc
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
Currently, to build any given utility, simply compile it using your system's
|
||||
C compiler. In general, this can be done with:
|
||||
`cc -std=c99 <util>`
|
||||
where <util> is the C file you wish to compile.
|
||||
|
||||
Note that tty requires you to add the flag `-D_XOPEN_SOURCE=700`
|
||||
(*Is this another GNU thing? Gods, it'd better not be...)
|
||||
|
||||
Portability
|
||||
-----------
|
||||
|
||||
Currently, fenutils is know to be working on Linux when compiled using GCC and
|
||||
glibc and on FreeBSD when compiled using clang and <freebsd c lib>. Testing is
|
||||
in progress for other OS/compiler combinations. If you have any success on other
|
||||
UNIX{,-like} systems, let us know.
|
||||
|
||||
Copyright
|
||||
---------
|
||||
|
||||
Licensed under CWPL v5 with CC-BY 4.0 by Katlynn Richey.
|
||||
|
||||
fenutils is free software. Feel free to modify and/or distribute it!
|
||||
See the file COPYING for more details.
|
Loading…
Reference in a new issue