summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 26 insertions, 7 deletions
diff --git a/README b/README
index ec378cf..905fce8 100644
--- a/README
+++ b/README
@@ -1,34 +1,53 @@
l3dfs
=====
-L3dfs (Linux-aided 3D File System) is a file system that provides 3D
-hardware-accelerated rendering to Plan 9.
+L3dfs (Linux-aided 3D File Server) is a project with the purpose of bringing
+hardware-accelerated 3D rendering capabilities to Plan 9, with the help of Linux
+and its vast and sophisticated driver collection and compatibility. More
+specifically, it is a group of software with two main components: a server that
+exposes the service described above and a client that accesses it. The two
+components communicate through the exchange of messages conforming to the 9P
+protocol and because of that, the software exposing the service effectively acts
+as a file server.
-Although it is meant for Plan 9, design and testing are done on
-[9front](https://9front.org).
+Although it is meant for Plan 9, it is designed for and tested on 9front
+(https://9front.org).
Design
------
-See doc/design.
+See doc/design.md.
Building
--------
+The C compilers available on Linux (typically gcc) and Plan 9 use slightly
+different variations of the C programming language. Because of that, and since
+the codebase results in separate programs anyway, the source code is split into
+two directories, one for Linux and one for Plan 9.
+
+From a user's perspective, the compilation of all source code is handled through
+comfortable makefiles. Again, there is one for Linux and one for Plan 9, since
+they vary slightly.
+
On Linux:
cd linux
make all
-On Plan 9: (to-do)
+On Plan 9:
+
+ cd plan9
+ mk all
Trivia
------
-Where did it all start? [Here](https://bsky.app/profile/supatwinkbasher.bsky.social/post/3madwusxthk2o)
+- It all started here:
+ https://bsky.app/profile/supatwinkbasher.bsky.social/post/3madwusxthk2o
License