summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdoardo La Greca2025-04-27 18:28:04 +0200
committerEdoardo La Greca2025-04-27 18:28:04 +0200
commitff08f22b94e7b8482747422b916edcf04051eb61 (patch)
treecf3b7b1b5b34e1a59e6c9dca504147198ba8ecfe
parent47948fdd0c206b633206cb40d7f5b7770e764454 (diff)
fix headings in readme
-rw-r--r--README14
1 files changed, 7 insertions, 7 deletions
diff --git a/README b/README
index 20c4ea9..2750d8c 100644
--- a/README
+++ b/README
@@ -1,17 +1,17 @@
femtokit
---------
+========
Femtokit is a graphical user interface toolkit. In other words, it provides an abstraction to the programmer in order to create graphical user interfaces without the need of manually manipulating the graphics primitives.
The name "Femtokit" is a wordplay between *femto* (a really small order of magnitude in the SI prefixes, 10^-15 to be exact) and *"tokit"*, an abbreviation of "toolkit".
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.
Compilation and usage
-=====================
+---------------------
As I may have said somewhere else, you need **OpenGL** (development version, that with header files) and **freeGLUT** (development version for this one as well).
@@ -25,19 +25,19 @@ Using the make file in the repository's root:
The ultimate object file is a library called `libfemtokit`, which is
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`.
Aesthetics
-==========
+----------
Follow the aesthetics.
-License (or, "Can I steal your code?")
-======================================
+License (or "Can I steal your code?")
+--------------------------------------
Unlicense, see LICENSE. (Yes.)