source: xtideuniversalbios/wiki/BuildInstructions.wiki @ 383

Last change on this file since 383 was 383, checked in by aitotat@…, 12 years ago

Edited wiki page BuildInstructions through web user interface.

File size: 3.8 KB
Line 
1#summary How to build XTIDE Universal BIOS.
2
3= Introduction =
4
5This is a small tutorial on how to build XTIDE Universal BIOS on Windows.
6
7
8= Programs needed =
9
10  * [http://tortoisesvn.tigris.org/ TortoiseSVN]
11  * [http://tdm-gcc.tdragon.net/ MinGW] (only mingw32-make.exe is needed)
12  * [http://www.nasm.us/ NASM]
13  * [http://upx.sourceforge.net/ UPX] (optional)
14  * [http://strawberryperl.com/ Strawperry Perl] (optional)
15
16
17== Install Tortoise SVN ==
18
19TortoiseSVN is a subversion client that is very easy to use since it integrates nicely to Windows. It is used to download XTIDE Universal BIOS sources. Anyone can download sources from coogle.code repository but you must be a project member to commit changed back to the repository.
20
21First [http://tortoisesvn.net/downloads.html download and install TortoiseSVN]. You can use the default settings that the installer suggests. Next you need to create folder where you want to download the sources. We name the folder _XTIDE Universal BIOS sources_ in this example.
22
23=== Downloading sources ===
24
25Once the directory is created, open it and click right mouse button. You will find _SVN Checkout..._ from the menu.
26
27
28URL for the repository is http://xtideuniversalbios.googlecode.com/svn/trunk/. There is no need to alter other settings so just click OK. You have now downloaded all sources from XTIDE Universal BIOS project.
29
30=== Updating sources ===
31
32If you have already done all above and want to get latest sources, go to the source folder you have created. Click right mouse button and select _SVN Update_. Using TortoiseSVN is really this easy!
33
34
35== Install MinGW ==
36
37MinGW is a free C/C++ compiler suite for Windows. We only need make utility from it but installing the whole MinGW is easier since it will add path to the environment variables automatically. Download the bundle installer ([http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.6.1.exe/download tdm-gcc-4.6.1.exe] when writing this) and install it with default settings. It will install the MinGW to C:\MinGW32. Keep this in mind since you'll want to install NASM to C:\MinGW\bin so there will be no need to change environment path.
38
39
40== Install NASM ==
41
42NASM is the assembler that is used to compile the sources. NASM v2.10 stable is what we are using when writing this. Download the [http://www.nasm.us/pub/nasm/releasebuilds/2.10/win32/nasm-2.10-win32.zip nasm-2.10-win32.zip] and extract nasm.exe to C:\MinGW32\bin (if you installed MinGW to C:\MinGW32\).
43
44
45== Install UPX (optional) ==
46
47UPX is used to compress XTIDE Universal BIOS configurator. It is only used to make release build. The only advantage is that it makes the executable size smaller.
48
49
50== Install Strawberry Perl (optional) ==
51
52Strawberry Perl is required to execute optional scripts when building XTIDE Universal BIOS. Scripts include string compression (not needed unless you modify the sources) and checksum calculation. Just run the Strawberry Perl installer with default settings.
53
54
55= Building XTIDE Universal BIOS =
56
57Open command line window and navigate to the folder where you downloaded the sources using TortoiseSVN. Then go to the _XTIDE_Universal_BIOS_ folder. Write _mingw32-make all_ and everything should be build.
58
59You might want to write _mingw32-make checksum_ if you installed Stawberry Perl. It will calculate checksum bytes to the binaries (You can use XTIDECFG.COM for that if you don't want to install Stawberry Perl).
60
61You will find the binaries in build\ folder.
62
63
64== Including and excluding optional modules ==
65
66This will be done soon.
67
68
69
70= Building Configurator (XTIDECFG.COM) =
71
72You should always use up to date configurator but note that configurator usually lags behind XTIDE Universal BIOS when new features are concerned.
73
74_mingw32-make all_ builds the XTIDECFG.COM. You should write _mingw32-make release_ if you installed UPX.
75
76Again you will find the binaries in build\ folder.
Note: See TracBrowser for help on using the repository browser.