X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fgmqcc.git;a=blobdiff_plain;f=README;h=993b8fb5d3b5f760426fa7efc8c017427d992b0d;hp=4ecb4db06f5fd6bb23d7dd4925f5c81718f05222;hb=e006aa82388218f0f18e93087217d1aa0c2cee83;hpb=a440c1410bad2a06b6a9385094a3dae0142f9395 diff --git a/README b/README index 4ecb4db..993b8fb 100644 --- a/README +++ b/README @@ -1,46 +1 @@ -This is my work in progress Quake C compiler. There are very few _good_ QC -compilers out there on the internet that can be used in the opensource -community. There are a lot of mediocre compilers, but no one wants those. -This is the solution for that, for once a proper Quake C compiler that is -capable of doing proper optimization. The design so far of this compiler -is basic, because it doesn't actually compile code yet. - -gmqcc.h - This is the common header with all definitions, structures, and - constants for everything. - -error.c - This is the error subsystem, this handles the output of good detailed - error messages (not currently, but will), with colors and such. - -lex.c - This is the lexer, a very small basic step-seek lexer that can be easily - changed to add new tokens, very retargetable. - -main.c - This is the core compiler entry, handles switches (will) to toggle on - and off certian compiler features. - -parse.c - This is the parser which goes over all tokens and generates a parse tree - (not currently, but will) and check for syntax correctness. - -typedef.c - This is the typedef system, this is a seperate file because it's a lot more - complicated than it sounds. This handles all typedefs, and even recrusive - typedefs. - -README - This is the file you're currently reading - -Makefile - The makefile, when sources are added you should add them to the SRC= - line otherwise the build will not pick it up. Trivial stuff, small - easy to manage makefile, no need to complicate it. - Some targets: - #make gmqcc - Builds gmqcc, creating a gmqcc binary file in the current - directory as the makefile. - - #make clean - Cleans the build files left behind by a previous build +An improved QuakeC compiler