summaryrefslogtreecommitdiff
path: root/README
blob: 905fce8214a89c0bf64dc00ca57d8b780b264954 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
l3dfs
=====

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, it is designed for and tested on 9front
(https://9front.org).


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:

	cd plan9
	mk all


Trivia
------

- It all started here:
  https://bsky.app/profile/supatwinkbasher.bsky.social/post/3madwusxthk2o


License
-------

GNU GPLv3. See LICENSE.