Skip to content

Commit

Permalink
Renamed README, made it an org file
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin Zaporzan committed Apr 28, 2011
1 parent 24018ef commit abcdf6d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
23 changes: 0 additions & 23 deletions README

This file was deleted.

27 changes: 27 additions & 0 deletions README.org
@@ -0,0 +1,27 @@
* What is Kampf
Kampf is a game developed to take advantage of a flexible
design. Speed isn't of necessity, but anything that can, should be
optimized in time.

* Explanation of different directories
- kampf.org :: includes a basic idea of what needs to be finished,
and small jots on ideas behind how to implement
certain elements of the engine, and what should be
expected out of the engine.

*NOTE*
/The org extension comes from the popular org-mode extension in emacs/

- kampf_UML_diagram.dia :: is a small diagram, which shows the
underlying structure. This is not concrete and will be changed
if there are more design constraints or ends up becoming
inflexible for later implementations. Runs in the program 'dia'
[[http://projects.gnome.org/dia/]]

- kampf_UML_diagram.png :: export of kampf_UML_diagram.dia

* Compiling
venture to ./src and run the makefile with *make* the executable is
placed in the parent folder

In this future, I will developing autotools extension to the project.

0 comments on commit abcdf6d

Please sign in to comment.