You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,41 @@ You can find the latest pre-compiled binaries on the [github project release pa
6
6
The binary installers of previous versions is also available [here](https://github.com/end2endzone/ShellAnything/releases).
7
7
8
8
You can also checkout the [latest builds / nightly builds](https://ci.appveyor.com/project/end2endzone/shellanything) available on AppVeyor which offers CI/CD services for Windows. Successful builds are identified by a vertical green line. Select the *current build* or one [from the history](https://ci.appveyor.com/project/end2endzone/shellanything/history). Click on the `Platform: x64` , then look in the `Artifacts` tab. In the *Actifacts* section, you will find two installers, one is a traditional "setup.exe" and the other is a more modern MSI. A portable version is also available.
9
-
9
+
10
+
11
+
12
+
### Using the build scripts: ###
13
+
14
+
To install ShellAnything on the system in "one click", one can use the build script which builds ShellAnything with default settings. This is the recommended way to build ShellAnything if you just want to use the application.
15
+
16
+
The following steps show how to install the application:
17
+
18
+
1) Download the source code from an existing [tags](http://github.com/end2endzone/ShellAnything/tags) and extract the content to a local directory (for example `c:\projects\ShellAnything`). It is recommended to use a directory path without spaces.
19
+
20
+
2) Execute the build script `build_with_defaults.bat` located in the `ci/local` directory.
21
+
22
+
The `build_with_defaults.bat` script emulates [AppVeyor](https://ci.appveyor.com/project/end2endzone/shellanything) environment and executes, one by one, AppVeyor's build scripts which are located in the `ci/appveyor` directory.
23
+
24
+
The following steps will be executed :
25
+
- All required library dependencies will be downloaded and build in `third_parties` directory located at the root of the source code. Existing dependencies that are already available on the system are **ignored**. This is to make sure that each dependency is build with settings that are compatible with ShellAnything and installed in the directory expected by the build scripts.
26
+
- ShellAnything application will be build inside the `build` directory located at the root of the source code.
27
+
- Installation packages will be created in the `build` directory if the required package managers are available on the system (NSIS, Wix Toolset). The installation packages are named as follows :
28
+
-`ShellAnything-[version]-win64.exe`, if NSIS is installed on the system.
29
+
-`ShellAnything-[version]-win64.msi`, if Wix Toolset is installed on the system.
30
+
-`ShellAnything-[version]-win64.zip`, a portable version.
31
+
- Application files will be installed in the `install` directory located at the root of the source code.
32
+
33
+
To delete all generated binaries, delete the `build`, `install` and `third_parties` directories.
34
+
35
+
36
+
10
37
### From the source code: ###
11
38
12
39
To install ShellAnything on the system from the source code, the source code must be compiled and copied to the appropriate directory.
13
40
14
41
The following steps show how to install the application:
15
42
16
-
1) Download the source code from an existing [tags](http://github.com/end2endzone/ShellAnything/tags) and extract the content to a local directory (for example `c:\projects\ShellAnything`).
43
+
1) Download the source code from an existing [tags](http://github.com/end2endzone/ShellAnything/tags) and extract the content to a local directory (for example `c:\projects\ShellAnything`). It is recommended to use a directory path without spaces.
17
44
18
45
2) Build the source code according to the [Build Steps](#build-steps) instructions specified in this document. It is suggested to define a custom installation directory. See the [CMake Quick Tips](#cmake-quick-tips) section for details.
19
46
@@ -161,5 +188,3 @@ To run tests, navigate to the `build/bin` folder and run `shellanything_unittest
161
188
Test results are saved in junit format in file `shellanything_unittest.x64.debug.xml` or `shellanything_unittest.x64.release.xml` depending on the selected configuration.
162
189
163
190
The latest test results are available at the beginning of the [README.md](README.md) file.
0 commit comments