diff options
author | Mihai Moldovan <ionic@ionic.de> | 2017-10-20 11:30:43 +0200 |
---|---|---|
committer | Mihai Moldovan <ionic@ionic.de> | 2017-10-20 11:30:43 +0200 |
commit | dae8551e22d51ba3926c8c165730145e53fb3c83 (patch) | |
tree | 1450e11b732c2eed087af7334992e93113fa111a | |
parent | c6b004578a6f16f68820818bb6424787e0a35e31 (diff) | |
download | nx-libs-dae8551e22d51ba3926c8c165730145e53fb3c83.tar.gz nx-libs-dae8551e22d51ba3926c8c165730145e53fb3c83.tar.bz2 nx-libs-dae8551e22d51ba3926c8c165730145e53fb3c83.zip |
README.md: add short Windows section and mention that using Cygwin tools is imperative when working with the git repository.
-rw-r--r-- | README.md | 11 |
1 files changed, 10 insertions, 1 deletions
@@ -136,7 +136,7 @@ The end result is RPMs under ~/result that you can install (or upgrade to) using Assuming: -1. The current version is 3.5.99* (specified in debian/changelog) +1. The current version is 3.5.99\* (specified in debian/changelog) Prerequisites: @@ -150,3 +150,12 @@ debuild -uc -us cd .. sudo dpkg -i *3.5.99*.deb ``` + +## Building on Windows + +The only components that can be built on Windows at the time of writing are `nxcomp` and `nxproxy` (with the latter utilizing the former). + +**The next section is only relevant for git-based source code builds. Released tarballs do not require special handling.** + +Since this project makes use of UNIX-style symlinks, it is imperative to clone the repository using Cygwin's git binary. MSYS(2) git is not able to handle UNIX-style symlinks. +Make sure that all build utilities are Cygwin-based. Non-Cygwin binaries will bail out with errors during the build process or insert garbage. |