diff doc/README @ 51:191654cf9855

* Fixed code::blocks unittest support; thanks to alexv for reporting * Updated AUTHORS * Removed old READMEs * Work in progress README for the upcoming release * Code::Blocks support on win32 currently broken, further investigation needed
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 13 Jul 2008 14:15:24 +0000
parents 4a0efb7baf70
children ab8b11adfb70
line wrap: on
line diff
--- a/doc/README	Sun Jul 13 13:14:04 2008 +0000
+++ b/doc/README	Sun Jul 13 14:15:24 2008 +0000
@@ -1,57 +1,33 @@
 == Introduction ==
-Welcome to the FIFE 2008.0 README. This snapshot is based on SVN revision 2109.
+Welcome to the FIFE 2008.1 README. This snapshot is based on SVN revision !FIXME.
 
 == Theme of this release ==
-For the 2008.0 release we decided to pick up the island_demo concept again. Right: again. We already used this concept for the 2007.1 release but we put it on ice as we worked together with the Zero-Projekt developers on a different example game for the 2007.2 release. The cooperation didn't work out as planned for either side and so both teams stick to their own projects again now.
+For the 2008.1 release we decided to flesh out the tropical island concept and called our example game "Rio de hola".
 
-After the cooperation has ended we considered all possible options and finally decided to flesh out the old island_demo concept and base our future example game upon it. Although we were able to finish the initial planning work for the new island_demo game some days ago, there is almost none of the new planned content in place yet. On the other side the engine itself and the editor tool that ships with it now made _huge_ steps forward since the last release about 4 months ago. Therefore we decided to release the current status as stable release although it offers not many new aspects on the content side and the content that is in place is very likely to change with the 2008.1 release.
+Caution: this release is still lacking a lot of polish, especially the "Rio de hola" game that ships with it. It lacks almost any form of gameplay but there is a reason why we decided to ship the release in its current form nevertheless. We planned to ship future FIFE releases under the LGPL to offer a less "restrictive" license to possible FIFE users (we know that the term "restrictive" is just our personal point of view).
 
-The milestone itself seems to be a very important step into the right direction. You can build your own maps now with the help of the editor tool. Furthermore a basic application structure is in place that should give you an idea how can create your own FIFE-based game. We'll surely adjust the structure of the island_demo client over the next months but this release is stable enough to start working on your game now.
+We had to clear up the legal situation first and fortunately the software freedom law center (http://www.softwarefreedom.org/) helped us with the transition. The agreement of all developers who contributed code that was still used in FIFE was needed and because over two dozens of people contributed code to the project, this took us a lot of time. We were not able to reach all of them so we decided to remove the code of the contributors who didn't reply to our license switch proposal mails.
 
-This release is surely not the beginning of the end of the road for us, but it's the end of beginning for the FIFE development team. Enjoy it as we do :-) 
+We were able to replace the last problematic code today so now FIFE is official LGPL'ed software. We're glad that we were able to make this step after it took us so long and we think that the new license alone is worth a release. Therefore we're proud to finally present the first FIFE release that is published under LGPL 2.1 or newer (your choice).
 
-== Important changes since the 2007.2 release ==
-* New audio module with support for some more advanced audio features.
-* Optimized view code to improve the performance and resolve map instance z-order issues.
-* Switched back to island_demo concept; this will be the example game that ships with future FIFE releases as well.
-* Ability to save maps
-* Routing pathfinding (previous release only had linear pather)
-* Pluggable rendering system. Several new plugins including:
-** Floating text renderer for map instances.
-** Blocking info renderer to show instance blocking info
-** Cell selection renderer for selection highlighting
-** Coordinate renderer for cellgrids
-** Quadtree renderer to show quadtree debug information
-* New editor tool, which can be used to layout maps
-* XML-format improvements: stack position, z-position, camera definitions, animation x/y offsets
-* Vastly improved pychan extension; XML based GUI definitions
-* Quadtree adjustments
-* Ability to define own settings formats and interpret them from scripts
-* Ability to attach cameras to instances (so that they are tracked while they move)
-* Separate x/y scaling for cellgrids, allows more flexible geometry definitions (e.g. rectangle)
-* Basic mouse map instance picking.
-* Editor tool (still work in progress).
-* Improved engine-script exception reporting
-* Mouse cursors can be changed from scripts
+Engine and the editor tool made _huge_ steps forward since the last release about 5 months ago. Therefore we decided to release the current status as stable release although it offers not many new aspects on the content side and the content that is in place is very likely to change with the 2008.2 release.
+
+The milestone itself seems to be a very important step into the right direction. You can build your own maps now with the help of the editor tool. Furthermore a basic application structure is in place that should give you an idea how can create your own FIFE-based game; this release is stable enough to start working on your game now :-)
 
-Few non-code related changes
-* Rough task list for the whole island demo has now been created:
-** https://mirror1.cvsdude.com/trac/fife/engine/report/3
-* Vastly improved documentation with nightly updates:
-** Core: http://fifedocs.boxbox.org//doxygen/
-** Scripts: http://fifedocs.boxbox.org//epydoc/
-* Lots of new content gathered and created for island demo 
-** E.g. agent definitions, clouds graphics, music...
+== Important changes since the 2008.0 release ==
+
+=== Non-code related changes ===
+* Switch from GPL to LGPL
 
 == Features ==
 * A complete list of the features that FIFE offers can be found at the project wiki:
 http://wiki.fifengine.de/index.php?title=Engine_features
 
 == License ==
-The source code (*.cpp, *.h & *.py) is licensed under GPL 2.0 or newer:
+The source code (*.cpp, *.h & *.py) is licensed under LGPL 2.1 or newer:
 http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 
-The island_demo content was taken from a lot a lot of different 3rd party sources. Therefore each content directory comes with a separate LICENSE file that states the origin of the content, the author and the actual license it was published under.
+Content was taken from a lot a lot of different 3rd party sources. Therefore each client directory comes with a separate LICENSE file that states the origin of the content, the author and the actual license it was published under.
 
 == Building FIFE ==
 === Dependencies ===
@@ -60,10 +36,10 @@
 
 === General notes ===
 FIFE utilizes the SCons (http://www.scons.org) build system. Here is a quick list of scons commands that can be important for building FIFE on your platform:
-* 'scons ext=1' will build the FIFE dependencies Guichan (http://guichan.sourceforge.net/) and minizip (http://www.winimage.com/zLibDll/minizip.html) from bundled source. Use this if you do not have these libraries, or have the wrong version.
+* 'scons ext=1' will build specific FIFE dependencies that usually don't reside in the most important Linux package managers from source.
 * 'scons -h' will list additional compile options.
 * 'scons' will build FIFE.
-* 'scons tests=1' will build FIFE and the boost unit tests (needed for test_fife.py).
+* 'scons tests=1' will build FIFE and the unittests (needed for test_fife.py).
 * 'scons -c' clears any compiled objects (= scons equivalent of 'make clean').
 
 Platform specific details how to build FIFE can be found down below.
@@ -113,4 +89,4 @@
 
 http://www.fifengine.de/
 
-2008/02/03
+2008/07/13