aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md7
-rw-r--r--docs/FAQ.md40
2 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
index c247263..7785ea7 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@
***Project Documentation***
+(!) Please note that documentation is incomplete and can be very outdated (!)
+
- [Compile fases](docs/COMPILE.md)
- [Mirrors](docs/MIRRORS.md)
@@ -14,6 +16,8 @@
- [Incomplete TODO list](docs/TODO.md)
+- [FAQ](docs/FAQ.md)
+
## Goal
The `fases` project tries to provide friendly, functionnal and simple core
@@ -22,6 +26,9 @@ be entirely portable and working on any UNIX-like Operating System and kernel
such as OpenBSD and Linux. It also tries to be completly modular and as such
one utility should **not** depend on another in order to work. The coreutils
are still a work-in-progress.
+The `fases` utilities are currently tested on Artix, Alpine, OpenBSD, OS X and
+FreeBSD. We expect all utilities to work on all systems implementing POSIX
+due to us using only POSIX-compliant functions.
## Directory structure
diff --git a/docs/FAQ.md b/docs/FAQ.md
new file mode 100644
index 0000000..d97d6ad
--- /dev/null
+++ b/docs/FAQ.md
@@ -0,0 +1,40 @@
+# fases - Ferass' Base System
+
+*Simple coreutils for a fully functionnal UNIX-like system*
+
+[« Go back](../README.md)
+
+## FAQ
+
+Here are questions someone could ask. Read it! It could answer some of your
+questions.
+
+Q: Why another coreutils? There's already GNU, Busybox, OpenBSD's, and some more.
+
+A: Most coreutils are either non-POSIX or use non-portable functions not
+specified by POSIX. The `fases` project separates POSIX and non-POSIX
+utilities while others do not. Some have also quite complex code, making it
+harder to study the code.
+
+[We're not trying to trash other coreutils. A lot of them
+(Busybox, OpenBSD, ...) are actually really good]
+
+Q: Is fases going to work on <insert UNIX-like operating system name here>?
+
+A: Well, it depends on the system itself. If your system implements POSIX
+functions in its libc, then it'll work. Utilities are currently tested on
+- OpenBSD ;
+
+- FreeBSD ;
+
+- OS X/Mac OS X/MacOS (just a little) ;
+
+- Artix Linux and Arch Linux ;
+
+- Alpine Linux.
+
+No. `fases` will never work on Microsoft Windows.
+
+---
+
+More coming soon.