diff options
| author | Edoardo La Greca | 2025-04-27 18:28:42 +0200 |
|---|---|---|
| committer | Edoardo La Greca | 2025-04-27 18:28:42 +0200 |
| commit | 4bcf53a0d6e617515b16c202e51c9619dc758c70 (patch) | |
| tree | 597d2443894694acb21fbf7d38820817284bb34a | |
| parent | ff08f22b94e7b8482747422b916edcf04051eb61 (diff) | |
rephrase and expand readme
| -rw-r--r-- | README | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -8,7 +8,12 @@ The name "Femtokit" is a wordplay between *femto* (a really small order of magni Goals ----- -The main goal of Femtokit is providing a **decent** (*comfortable*) **level of abstraction** over the raw graphics programming primitives, while also not sacrificing **freedom** (what the user can achieve), **compactness** and **minimal resource usage** (its size on disk and its hardware/software resources usage), or **dependence** on external software or hardware. +The main goal of Femtokit is providing a *comfortable level of abstraction* over the raw graphics programming primitives, while also not sacrificing *freedom* (what the user can achieve) or *minimal resource usage*. + +Other goals of Femtokit include the following: + +- Portability (being able to run on as many platforms as possible with little or no modification). +- Tying code as little as possible to third-party software or hardware. In other words, using mostly what's expected to be present in the end user's machine, both software-wise and hardware-wise. Compilation and usage --------------------- @@ -29,7 +34,7 @@ Repository structure The repository's root directory contains almost everything, including the source code, a header file with definitions for all symbols, and a make file. -Sub-directories contain secondary files and directories like scripts, images, data files, et cetera. Specifically, the scripts are in `scr`, images in `img`, and data files in `data`. +Sub-directories contain secondary files and directories like scripts, images, data files, documentation, manual pages, et cetera. Aesthetics ---------- |