Skip to content

Commit ced6a3e

Browse files
committed
Add windows installation notes
These notes and screenshots are based off of my experience installing and compiling the tools to compile LiveCode on Windows.
1 parent bb3edcb commit ced6a3e

9 files changed

+54
-3
lines changed

docs/development/build-win.md

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![LiveCode Community Logo](http://livecode.com/wp-content/uploads/2015/02/livecode-logo.png)
44

5-
Copyright © 2015-2017 LiveCode Ltd., Edinburgh, UK
5+
Copyright © 2015-2019 LiveCode Ltd., Edinburgh, UK
66

77
## Dependencies
88

@@ -16,13 +16,13 @@ You will need to install [git for Windows](https://git-scm.com/download/win) in
1616

1717
You need a set of Visual Studio build tools and SDKS. You can use either:
1818

19-
- [Microsoft Visual Studio 2015 Build Tools](https://www.microsoft.com/en-us/download/details.aspx?id=48159),
19+
- [Microsoft Visual Studio 2017 Build Tools](https://visualstudio.microsoft.com/downloads/?q=build+tools+2017#other),
2020
which contains _only_ the compilers and libraries, without any user
2121
interface; select everything in the installer
2222

2323

2424
- An appropriate edition of the
25-
[Microsoft Visual Studio 2015](https://visualstudio.microsoft.com/vs/older-downloads/) IDE
25+
[Microsoft Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) IDE
2626

2727
In addition, you should install
2828
[Microsoft Speech SDK 5.1](https://www.microsoft.com/en-gb/download/details.aspx?id=10121)
@@ -32,6 +32,22 @@ Note : If Using Microsoft Visual Studio 2017, you will need to add C++ support a
3232
support for the Windows 8.1 SDK to your Visual Studio installation as these features are currently
3333
not installed by default with Visual Studio 2017 and are necessary for building LiveCode.
3434

35+
#### Configure for C++ development
36+
37+
Select **Desktop development** with C++ as the install option.
38+
39+
![Install 1](./images/configure-for-c-development.png)
40+
41+
#### Add Windows 8.1 SDK and Visual C++ MFC for x86 and x64
42+
43+
![Install 2](./images/add-windows-81-sdk-and-visual-c-mfc-for-x86-and-x64.png)
44+
45+
#### Set up for Visual C++
46+
47+
When Visual Studio launches you will be prompted to log in and then decide how you want the environment configured. Select **Visual C++**.
48+
49+
![Install 3](./images/set-up-for-visual-c-.png)
50+
3551
### Cygwin
3652

3753
The build currently requires the use of some tools from the Cygwin distribution of GNU and other open source tools.
@@ -46,13 +62,32 @@ You need to [install Cygwin](https://cygwin.com/install.html), along with the fo
4662
* zip
4763
* unzip
4864

65+
When you get to the Select Packages screen in the Cygwin installer do the following:
66+
67+
1. Change the View to Full.
68+
2. Search for each additional package listed on the LiveCode web page.
69+
3. Click on Skip to mark it for installation.
70+
![Cygwin Install 1](./images/install-cygwin-with-additional-packages.png)
71+
4972
### Other tools
5073

5174
The build process also requires:
5275

5376
* [ActiveState Perl](https://www.activestate.com/activeperl/downloads) Community Edition
5477
* [Python 2.7](https://www.python.org/) (Python 3 isn't supported)
5578

79+
#### Perl install note: Add Perl to the PATH environment variable
80+
81+
The option to add Perl to PATH will be checked by default. Leave it checked.
82+
83+
![Perl Install 1](./images/add-perl-to-the-path-environment-variable.png)
84+
85+
#### Python install note: Add Python 2.7 to `PATH`
86+
87+
With the Python 2.7 installer you have to customize the installation so that the Python.exe is added to `PATH`. Scroll to the bottom of the list of customizations and activate **Add python.exe to Path**.
88+
89+
![Python Install 1](./images/add-python-27-to-path.png)
90+
5691
## Configuring LiveCode
5792

5893
Once you have checked out the source code from git, you can run:
@@ -65,6 +100,16 @@ cmd /C configure.bat
65100

66101
This will generate a set of Visual Studio project files in the `build-win-x86/livecode` directory.
67102

103+
### Set the LiveCode-all Debugging Command
104+
105+
In order to debug the IDE you need to configure the Debugging Command for LiveCode-all.
106+
107+
```
108+
$(TargetDir)\LiveCode-Community.exe
109+
```
110+
111+
![Debug with LiveCode](./images/set-the-livecode-all-debugging-command.png)
112+
68113
## Compiling LiveCode
69114

70115
If you installed the Visual Studio IDE, you can open the
@@ -78,3 +123,9 @@ cd build-win-x86
78123
set BUILD_PLATFORM=win-x86
79124
cmd /C ..\make.cmd
80125
````
126+
127+
## Build LiveCode-all
128+
129+
Build the LiveCode-all project to compile the engine and run the IDE.
130+
131+
![Debug with LiveCode](./images/build-livecode-all.png)
52.3 KB
Loading
132 KB
Loading
55.7 KB
Loading
116 KB
Loading
207 KB
Loading
233 KB
Loading
85.7 KB
Loading
55.5 KB
Loading

0 commit comments

Comments
 (0)