X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fgmqcc.git;a=blobdiff_plain;f=README;h=993b8fb5d3b5f760426fa7efc8c017427d992b0d;hp=b072829a76e3e61deb5e347adfd2d12c9c95de09;hb=966991601c346e7c0e952886e476258d86213aa7;hpb=248cd7af945adc9c5de019ec74c866626cd560ab

diff --git a/README b/README
index b072829..993b8fb 100644
--- a/README
+++ b/README
@@ -1,50 +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.
-	
-alloc.c
-	This is just an allocator for the compiler, it's used for debugging reasons
-	only.
-	
-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