1Squirrel 3.1 stable
2--------------------------------------------------------
3What is in this distribution?
4
5squirrel
6    static library implementing the compiler and interpreter of the language
7
8sqstdlib
9    the standard utility libraries
10
11sq
12    stand alone interpreter
13
14doc
15    The manual
16
17etc
18    a minimalistic embedding sample
19
20samples
21    samples programs
22
23
24HOW TO COMPILE
25---------------------------------------------------------
26CMAKE USERS
27.........................................................
28If you want to build the shared libraries under Windows using Visual
29Studio, you will have to use CMake version 3.4 or newer. If not, an
30earlier version will suffice. For a traditional out-of-source build
31under Linux, type something like
32
33 $ mkdir build # Create temporary build directory
34 $ cd build
35 $ cmake .. # CMake will determine all the necessary information,
36            # including the platform (32- vs. 64-bit)
37 $ make
38 $ make install
39 $ cd ..; rm -r build
40
41The default installation directory will be the top source directory,
42i. e. the binaries will go into bin/ and the libraries into lib/. You
43can change this behavior by calling CMake like this:
44
45 $ cmake .. -DCMAKE_INSTALL_PREFIX=/some/path/on/your/system
46
47With the INSTALL_BIN_DIR and INSTALL_LIB_DIR options, the directories
48the binaries & libraries will go in (relative to CMAKE_INSTALL_PREFIX)
49can be specified. For instance,
50
51 $ cmake .. -DINSTALL_LIB_DIR=lib64
52
53will install the libraries into a 'lib64' subdirectory in the top
54source directory. If INSTALL_INC_DIR is set, the public header files
55will be installed into the directory the value of INSTALL_INC_DIR
56points to. There is no default directory - if you want only the
57binaries and no headers, just don't specify INSTALL_INC_DIR, and no
58header files will be installed.
59
60Under Windows, it is probably easiest to use the CMake GUI interface,
61although invoking CMake from the command line as explained above
62should work as well.
63
64GCC USERS
65.........................................................
66There is a very simple makefile that compiles all libraries and exes
67from the root of the project run 'make'
68
69for 32 bits systems
70
71 $ make
72
73for 64 bits systems
74
75 $ make sq64
76
77VISUAL C++ USERS
78.........................................................
79Open squirrel.dsw from the root project directory and build(dho!)
80