Commits

Thejesh GN committed 6de4c6f

modified readme.

  • Participants
  • Parent commits b360a1d

Comments (0)

Files changed (1)

+## Welcome ##
+Welcome to my Quake study page. I am planning to read and understand the Quake code for fun and learning. I am electronics engineer and studied c as part of my course. Even though I turned out to be a software engineer later, I never did production C. I mostly use Python, JavaScript and Java. Last time I wrote decent C code was when I was in final year of engineering.
+
+I am not studying this to learn C programming. I am studying this just to enjoy the beauty of software produced by Johns. To explore whats behind that game.
+
+## Process ##
+Downloaded code from [ID Software's](ftp://ftp.idsoftware.com/idstuff/source/) ftp site. This repository is just a fork of it. I am adding comments as I read and understand the code. Then I will use [Pyyco](https://bitbucket.org/thejeshgn/pycco) to generated readable documentation.
+
+The repository helps others to contribute and track. Once its complete and I will publish the complete [documentation on my site](http://thejeshgn.com/). 
+
+## License ## 
+Its all under [GNU/GPL](http://code.thejeshgn.com/quake/src/tip/gnu.txt). You may want to read [John Carmack's release notes](http://code.thejeshgn.com/quake/src/tip/original-readme.txt).
+
+# Progress #