source: xtideuniversalbios/wiki/BuildInstructions.wiki @ 384

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

Edited wiki page BuildInstructions through web user interface.

File size: 3.9 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
18= Install Tortoise SVN =
19
20TortoiseSVN 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 changes back to the repository.
21
22First [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.
23
24== Downloading sources ==
25
26Once the directory is created, open it and click right mouse button. You will find _SVN Checkout..._ from the menu.
27
28
29URL 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.
30
31== Updating sources ==
32
33If 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!
34
35
36
37= Install MinGW =
38
39MinGW 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:\MinGW32\bin so there will be no need to change environment path.
40
41
42
43= Install NASM =
44
45NASM 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\).
46
47
48
49= Install UPX (optional) =
50
51UPX is used to compress XTIDE Universal BIOS configurator. It is needed only for release build. The only advantage is that it makes the executable size smaller.
52
53
54
55= Install Strawberry Perl (optional) =
56
57Strawberry 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.
58
59
60
61= Building XTIDE Universal BIOS =
62
63Open command line window and go to the folder where you downloaded the sources with TortoiseSVN. Then go to the _XTIDE_Universal_BIOS_ folder. Write _mingw32-make all_ and everything should be build.
64
65You 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).
66
67You will find the binaries in _build\_ folder.
68
69
70== Including and excluding optional modules ==
71
72This will be done soon.
73
74
75
76= Building Configurator (XTIDECFG.COM) =
77
78You should always use up to date configurator but note that configurator usually lags behind XTIDE Universal BIOS when new features are concerned.
79
80Go to _XTIDE_Universal_BIOS_Configurator_v2_ folder and write _mingw32-make all_ to build the XTIDECFG.COM. You should write _mingw32-make release_ if you installed UPX.
81
82Again you will find the binaries in _build\_ folder.
Note: See TracBrowser for help on using the repository browser.