Merge branch 'master' of ssh://git.code.sf.net/p/maxima/code
[maxima.git] / macosx / Readme.md
bloba1dba9e1f1b737d503ac9cdf51e62601eafe75ef
1 MAXIMA.APP
2 ===========
4 Quick instructions for building a Maxima.app on Mac OS X.
6 Platypus
7 ---------
9 The package is built with the Platypus application. Install Platypus
10 from http://sveinbjorn.org/platypus. You also need to install the
11 command line tools (start the Platypus application and install command
12 line tools from the Preferences dialog).
14 Maxima.app
15 -----------
17 The default configuration uses sbcl which is installed as
18 /usr/local/bin/sbcl, but other lisps can be used too. It creates a
19 Maxima.app on the Desktop.
21 To create Maxima.app with default settings execute
23    make -f macosx/Makefile
25 To use a different lisp and set the version execute
27     make -f macosx/Makefile VERSION=5.24.0 LISP_NAME=cmucl \
28       LISP_PROGRAM=/usr/local/bin/lisp
30 Maxima will be configured with correct options, built and installed
31 into Maxima.app. Some parts of Maxima.app are created with Platypus.
33 Running Maxima
34 ---------------
36 Double-cliking Maxima.app starts maxima in a new Terminal window.
38 To run maxima from Terminal, execute
39 Maxima.app/Contents/Resources/maxima.sh
41 Creating a .dmg file with maxima and wxMaxima
42 ---------------------------------------------
44  - Open the Disk Utility
45  - Create a new Disk Image (read/write; fixed size and big enough for maxima and
46    wxmaxima. If there is empty space at the end of the image that is fine: After
47    compressing the image it won't use up much disk space any more)
48  - Double-click on it and open the newly-mounted .dmg in the Finder.
49  - Move maxima and wxMaxima into the finder window.
50  - In case that the gnuplot project doesn't build a gnuplot image in a format we
51    can include besides maxima and wxMaxima a suitable gnuplot may be found at
52    http://ricardo.ecn.wfu.edu/pub/gnuplot.
53  - Add "How to install.rtf" to the image.
54  - Create a symlink to /Applications in the folder containing the three
55    applications
56  - Switch the window to icon view and arrange icons as needed.
57  - Go to the "view options" and add a maxima Logo as the background
58  - re-enter the Disk Utility
59  - return to the Disk Utility, right-click on the .dmg disk image
60    and select "Convert to read-only".
61  - Done.