view: entities-list in plane and fixes

[rulp/rulp.git] / README

diff --git a/README b/README
index e494d21..5f6ecc5 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ It is a virtual board for roleplay games, it display a table
 with a grid to simulate battles and scenaries. It include
 an editor to create your own map and events.
 
-## Install
+## Install on Linux
 
 The software is released as binaries on the osdn page in both appimage
 with dependencies and rpm/deb. This software uses raylib, tcl and tk to
@@ -34,8 +34,49 @@ $ make
 Or if you don't use buildapp you can use the asdf tools for that:
 
 $ cd /path/to/sources
-$ sbcl --load system.asd
+$ sbcl --load rulp.asd
 * (require :rulp)
 * (asdf:make :rulp)
 
 Then use CTRL+D to exit console.
+
+## Install on Windows
+
+To compile on windows you need sbcl and the dlls SDL2.dll,
+SDL2-image.dll and SDL2-ttf.dll.
+
+First you can install sbcl from the website or with chocolatey
+with
+
+# choco install sbcl
+
+(here the # indicate that you use administrator powershell).
+
+The dlls can be downloaded from the sdl2, sdl2-image and sdl2-ttf
+github pages selecting the win32-x64 version. The dlls should
+be copied in the rulp folders.
+
+also you need to download the libffi sources and copy the ffi.h and
+ffi-target.h files for later use.
+
+Start sbcl on your folder and install quicklisp as written on
+the website beta.quicklisp.org.
+
+With quicklisp installed, use the commands
+
+* (ql:quickload "clingon")
+* (ql:quickload "sdl2")
+* (ql:quickload "sdl2-image")
+* (ql:quickload "sdl2-ttf")
+
+sdl2-ttf should fail because it misses the ffi.h files. These files
+need to be placed into
+quicklisp\dists\quicklisp\software\libffi[whatever version]\
+and retry the last command.
+
+Now you should be able to start and compile rulp. Without using
+the makefile just execute
+
+> sbcl --load "rulp.asd" --eval "(progn (require :rulp) (asdf:make :rulp))"
+
+The sbcl.exe executable should in the folder.