From abcdf6df2848c39a0ddf627874267d1576560cf9 Mon Sep 17 00:00:00 2001 From: Benjamin Zaporzan Date: Thu, 28 Apr 2011 19:57:31 -0400 Subject: [PATCH] Renamed README, made it an org file --- README | 23 ----------------------- README.org | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 23 deletions(-) delete mode 100644 README create mode 100644 README.org diff --git a/README b/README deleted file mode 100644 index d2b8524..0000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -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. - -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 - diff --git a/README.org b/README.org new file mode 100644 index 0000000..3959df7 --- /dev/null +++ b/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.