Tscope5
tscope5-0.6/00installation.md
1 # Tscope5 installation manual
2 
3 [TOC]
4 
5 # Windows {#wininstall}
6 
7 We bundled all the tools (compiler, libraries, fonts, custom scripts) that Tscope5 relies on into a single installer package called Mingw4Tscope5.
8 
9 Tscope5 itself is not part of MinGW4Tscope5, as it is updated more frequently.
10 
11 After the installation of MinGW4Tscope5, you will still need to install Tscope5 as described in the next section.
12 
13 ## Mingw4Tscope5
14 
15 Download the installer <a href="download/MinGW4Tscope5-0.6.exe"> here</a>. It is about 450 megabytes.
16 
17 - Execute the installer. You will need administrative rights to run the installer. A power user account is not enough. If you don't have administrative rights,
18  the installer will tell you and abort.
19 - There are not many installation options. Mingw4Tscope5 will not install in the standard Program Files directory because of the space in that directory's name. It will be installed in C:\\Mingw4Tscope5 instead. (Actually, Mingw4Tscope5 will be installed on the same drive as your Windows system - so if Windows is installed on the D: drive, Mingw4Tscope5 will be installed in D:\\Mingw4Tscope5, etc. All further information on this site assumes Mingw4Tscope5 is installed in C:\\Mingw4Tscope5, but please note that on your system this also might be D:\\Mingw4Tscope5 or any other drive).
20 - If everything is ok, the installer will extract all the necessary files. This can take a while - the fully extracted system takes about 500 megabytes of disk space.
21 
22 After installation an icon called 'MinGW4Tscope5 will be added to your desktop. Double clicking this icon will open a bash shell where you can enter your compilation commands.
23 
24 ## Tscope5
25 
26 - For Windows we provide an automatic installer that can be downloaded <a href="download/tscope5-0.6.exe"> here</a>.
27 - Execute the installer in the same way as the MinGW4Tscope5 installer. Again there are no installation options. After installation you are ready to start developing Tscope5 programs.
28 
29 The distribution currently contains a version of <a href="http://notepad-plus-plus.org" target="_blank"> notepad++</a> that has some predefined <a href="md_tscope5-0_86_00compilation.html"> shortcuts </a> to compile and run Tscope5 programs.
30 
31 You can also compile and run Tscope5 programs using the shell commands described in <a href="md_tscope5-0_86_00compilation.html"> the compilation manual </a>.
32 
33 
34 # Mac OS X {#macinstall}
35 
36 ## Xcode
37 
38 First you will need to install Xcode, Apple's development environment. It can be downloaded for free from the App Store. The download can take a while, it is about 3.5 Gigabytes.
39 
40 Once it is installed open it (you can find it in the Applications folder). At first launch, some components will be installed or upgraded. That may also take a while.
41 
42 Then open a Terminal `(Applications/Utilities/Terminal)` and install the command line tools by typing
43 
44  sudo xcode-select --install
45 
46 ## MacPorts
47 
48 The next step is to install MacPorts. MacPorts provides an infrastructure for building, installing and packaging open source software. It can be downloaded <a href="http://www.macports.org/install.php" target="_blank"> here</a>.
49 
50 Make sure you download a version that is compatible with your version of OS X (versions for Mavericks, Mountain Lion and Lion are available).
51 
52 Once you have installed MacPorts open a Terminal `(Applications/Utilities/Terminal)` and copy-paste the commands described below.
53 
54 First you will need to update your package repository list:
55 
56  sudo port selfupdate
57 
58 Then you can install the libraries that are needed by Allegro5:
59 
60  sudo port install cmake wget gsl zlib freetype jpeg libogg physfs libpng flac libtheora +universal
61 
62 That process will also take a while.
63 
64 ## Allegro5
65 
66 Then you can install Allegro5
67 
68  cd /usr/local/
69  sudo mkdir -p src
70 
71  cd src
72  sudo wget http://expsy.ugent.be/tscope5/download/allegro-5.1.13.tar.bz2
73 
74  sudo tar -xjf allegro-5.1.13.tar.bz2
75 
76  cd allegro-5.1.13
77  mkdir Build
78  cd Build
79  cmake ..
80  make
81  sudo make install
82 
83 
84 ## Fonts
85 
86 Install the fonts needed by Tscope5
87 
88  cd /usr/local/share
89  sudo wget http://expsy.ugent.be/tscope5/download/tscope5_data.tar.bz2
90 
91  sudo tar -xjf tscope5_data.tar.bz2
92 
93 
94 ## Tscope5
95 
96 And finally install Tscope5
97 
98  cd /usr/local/src
99  sudo wget http://expsy.ugent.be/tscope5/download/tscope5-0.6.tar.bz2
100 
101  sudo tar -xjf tscope5-0.6.tar.bz2
102 
103  cd tscope5-0.6
104  sudo make install-macosx
105 
106 If you want to update Tscope5 you will only need to run this last block of commands.
107 
108 A good text editor for Mac OS X is textmate. It can be downloaded <a href="http://macromates.com/" target="_blank"> here</a>.
109 
110 
111 # Linux (Ubuntu) {#lininstall}
112 
113 To get Tscope5 running on Linux, open a terminal window and copy-paste the commands described below.
114 
115 
116 ## Development tools
117 
118 First you will need to update your package repository list:
119 
120  sudo apt-get update
121 
122 Then you can install the development tools
123 
124  sudo apt-get install build-essential git cmake cmake-curses-gui xorg-dev libgl1-mesa-dev libglu-dev
125 
126 And install the Allegro5 addons
127 
128  sudo apt-get install libpng-dev libcurl4-openssl-dev libfreetype6-dev libjpeg-dev libvorbis-dev \
129  libopenal-dev libphysfs-dev libgtk2.0-dev \
130  libasound-dev libpulse-dev libflac-dev libdumb1-dev \
131  libtheora-dev libgsl0-dev
132 
133 
134 ## Allegro5
135 
136 Then you can install Allegro5
137 
138  cd /usr/local/
139  sudo mkdir -p src
140  cd src
141  sudo wget http://expsy.ugent.be/tscope5/download/allegro-5.1.13.tar.bz2
142 
143  sudo tar -xjf allegro-5.1.13.tar.bz2
144 
145  cd allegro-5.1.11
146  mkdir Build
147  cd Build
148  cmake ..
149 
150  make
151 
152  sudo make install
153 
154  sudo ldconfig
155 
156 ## Fonts
157 
158 Install the fonts needed by Tscope5
159 
160  cd /usr/local/share
161  sudo wget http://expsy.ugent.be/tscope5/download/tscope5_data.tar.bz2
162 
163  sudo tar -xjf tscope5_data.tar.bz2
164 
165 ## Tscope5
166 
167 And finally install Tscope5
168 
169  cd /usr/local/src
170  sudo wget http://expsy.ugent.be/tscope5/download/tscope5-0.6.tar.bz2
171 
172  sudo tar -xjf tscope5-0.6.tar.bz2
173 
174  cd tscope5-0.6
175  sudo make install-linux
176 
177  sudo ldconfig
178 
179 If you want to update Tscope5 you will only need to run this last block of commands.
180 
181 
182 # Raspberry Pi (Raspbian) {#raspinstall}
183 
184 To get Tscope5 running on the Raspberry Pi, open a terminal window and copy-paste the commands described below.
185 
186 
187 ## Development tools
188 
189 First you will need to update your package repository list:
190 
191  sudo apt-get update
192 
193 Then you can install the development tools
194 
195  sudo apt-get install build-essential git cmake cmake-curses-gui xorg-dev libgl1-mesa-dev libglu-dev
196 
197 
198 ## Wiring Pi
199 
200 Then you can install Wiring Pi, an interface to the GPIO
201 
202  cd /usr/local/src
203  sudo apt-get install git-core
204  sudo git clone git://git.drogon.net/wiringPi
205  cd wiringPi
206  sudo git pull origin
207  sudo ./build
208 
209 
210 ## Allegro5
211 
212 First install the Allegro5 addons
213 
214  sudo apt-get install libpng-dev libcurl4-openssl-dev libfreetype6-dev libjpeg-dev libvorbis-dev \
215  libopenal-dev libphysfs-dev libgtk2.0-dev \
216  libasound-dev libpulse-dev libflac-dev libdumb1-dev \
217  libtheora-dev libgsl0-dev
218 
219 
220 Then you can install Allegro5
221 
222  cd /usr/local/
223  sudo mkdir -p src
224 
225  cd src
226  sudo wget http://expsy.ugent.be/tscope5/download/allegro-5.1.13.tar.bz2
227 
228  sudo tar -xjf allegro-5.1.13.tar.bz2
229 
230 
231 On Raspbian the next step is:
232 
233  cd allegro-5.1.13
234  sudo mkdir Build
235  cd Build
236  sudo cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-raspberrypi.cmake -DFREETYPE_INCLUDE_DIRS=/usr/include/freetype2
237  sudo make
238 
239  sudo make install
240  sudo cp -r ../include/allegro5/* /usr/local/include/allegro5
241 
242  sudo ldconfig
243 
244 
245 ## Fonts
246 
247 Install the fonts needed by Tscope5
248 
249  cd /usr/local/share
250  sudo wget http://expsy.ugent.be/tscope5/download/tscope5_data.tar.bz2
251 
252  sudo tar -xjf tscope5_data.tar.bz2
253 
254 
255 ## Tscope5
256 
257 And finally install Tscope5
258 
259  cd /usr/local/src
260  sudo wget http://expsy.ugent.be/tscope5/download/tscope5-0.6.tar.bz2
261 
262  sudo tar -xjf tscope5-0.6.tar.bz2
263 
264  cd tscope5-0.6
265  sudo make install-raspberrypi
266 
267  sudo ldconfig
268 
269 If you want to update Tscope5 you will only need to run this last block of commands.
270