diff --git a/README.md b/README.md index 1449e8b..e9f64ac 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ Slipstream Mod Manager -===================== +====================== -Slipstream is the successor to Grognak's Mod Manager (GMM), a program designed to make it easy to install multiple [FTL](http://www.ftlgame.com/) mods at the same time. +Slipstream is a mod manager for the game FasterThanLight ([FTL](http://www.ftlgame.com/)), making it easy to install multiple mods at the same time and, later, revert to vanilla gameplay. + +It is the successor to Grognak's Mod Manager ([GMM](http://www.ftlgame.com/forum/viewtopic.php?p=9994)). + + To download compiled binaries, [click here](https://sourceforge.net/projects/slipstreammodmanager/). diff --git a/img/screenshot01.png b/img/screenshot01.png new file mode 100644 index 0000000..eb16d7a Binary files /dev/null and b/img/screenshot01.png differ diff --git a/readme_developers.txt b/readme_developers.txt index 49d9c4b..8397f65 100644 --- a/readme_developers.txt +++ b/readme_developers.txt @@ -6,33 +6,38 @@ The build process for this project is automated by Maven. To build, run "mvn clean" and "mvn package" in this folder. +"img/" + Screenshots. -"skel_common/" contains files to include in distribution archives. +"skel_common/" + Files to include in distribution archives. -"skel_win/" and "skel_unix/" are for system specific dist files. +"skel_win/" and "skel_unix/" + System-specific files to include in distribution archives. - - -"skel_exe/" contains materials to create modman.exe (not part of Maven). - -- Get Launch4j: http://launch4j.sourceforge.net/index.html -- Drag "launch4j.xml" onto "launch4jc.exe". -- "modman.exe" will appear alongside the xml. -- Drag modman.exe into "skel_win/". -- "mvn clear" and "mvn package". +"skel_exe/" + Materials to create modman.exe (not part of Maven). + - Get Launch4j: http://launch4j.sourceforge.net/index.html + - Drag "launch4j.xml" onto "launch4jc.exe". + - "modman.exe" will appear alongside the xml. + - Drag modman.exe into "skel_win/". + - Run "mvn clear" and "mvn package". This project depends on the following libraries. - Jackson JSON Processor 2.x http://jackson.codehaus.org/Home - (JavaDoc links are on the right.) + (For JavaDocs, look right.) - PNGJ https://code.google.com/p/pngj/ + (For JavaDocs, scroll down.) - JDOM 2.x http://www.jdom.org/ -- log4j + (For JavaDocs, look left.) +- log4j2 http://logging.apache.org/log4j/2.x/ + (JavaDocs are not available.)