Cleaups and README
[xonotic/gmqcc.git] / README
1 This is my work in progress Quake C compiler. There are very few _good_ QC
2 compilers out there on the internet that can be used in the opensource
3 community.  There are a lot of mediocre compilers, but no one wants those.
4 This is the solution for that, for once a proper Quake C compiler that is
5 capable of doing proper optimization.  The design so far of this compiler
6 is basic, because it doesn't actually compile code yet.
7
8 gmqcc.h
9         This is the common header with all definitions, structures, and
10         constants for everything.
11
12 error.c
13         This is the error subsystem, this handles the output of good detailed
14         error messages (not currently, but will), with colors and such.
15         
16 lex.c
17         This is the lexer, a very small basic step-seek lexer that can be easily
18         changed to add new tokens, very retargetable.
19         
20 main.c
21         This is the core compiler entry, handles switches (will) to toggle on
22         and off certian compiler features.
23         
24 parse.c
25         This is the parser which goes over all tokens and generates a parse tree
26         (not currently, but will) and check for syntax correctness.
27         
28 typedef.c
29         This is the typedef system, this is a seperate file because it's a lot more
30         complicated than it sounds.  This handles all typedefs, and even recrusive
31         typedefs.
32         
33 README
34         This is the file you're currently reading
35         
36 Makefile
37         The makefile, when sources are added you should add them to the SRC=
38         line otherwise the build will not pick it up.  Trivial stuff, small
39         easy to manage makefile, no need to complicate it.
40         Some targets:
41                 #make gmqcc
42                         Builds gmqcc, creating a gmqcc binary file in the current
43                         directory as the makefile.
44                         
45                 #make clean
46                         Cleans the build files left behind by a previous build