From ca1ec9b506b117ffba11c526c8c9523eed691e2a Mon Sep 17 00:00:00 2001 From: Don HO Date: Wed, 5 Feb 2020 20:00:45 +0100 Subject: [PATCH] Make README.md more readable --- BUILD.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 66 +++---------------------------------------------------- 2 files changed, 68 insertions(+), 63 deletions(-) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 00000000..0fec68e2 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,65 @@ +How to build Notepad++ +---------------------- + +There are two components that need to be built separately: + + - `notepad++.exe`: (depends on `SciLexer.dll`) + - `SciLexer.dll` : (with nmake) + +You can build Notepad++ with *or* without Boost - The release build of +Notepad++ is built **with** Boost. + +Since `Notepad++` version 6.0, the build of `SciLexer.dll` that is distributed +uses features from Boost's `Boost.Regex` library. + +You can build SciLexer.dll without Boost, ie. with its default POSIX regular +expression support instead of boost's PCRE one. This is useful if you would +like to debug Notepad++, but don't have boost. + +## To build `notepad++.exe`: + + 1. Open [`PowerEditor\visual.net\notepadPlus.vcxproj`](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/visual.net/notepadPlus.vcxproj) + 2. Build Notepad++ like a normal Visual Studio project. + + + +## To build `SciLexer.dll` with boost: + +Here are the instructions to build SciLexer.dll (for both 32-bit & 64-bit) for Notepad++: + + 1. Download the [Boost source code](https://www.boost.org/users/history/version_1_70_0.html). + 2. Unzip boost. In my case, It's unzipped in `C:\sources\boost_1_70_0` + 3. Build regex of boost. With the version 1.70, launch `bootstrap.bat` under the boost root, `b2.exe` will be generated beside of `bootstrap.bat`. For building boost PCRE lib, go into regex build directory by typing `cd C:\sources\boost_1_70_0\libs\regex\build` then launch `C:\sources\boost_1_70_0\b2.exe toolset=msvc link=static threading=multi runtime-link=static address-model=64 release stage`. + Note that **address-model=64** is optional if you want to build lib in 64 bits. For 32 bits build, just remove **address-model=64** from the command line. + 4. Copy generated message from `C:\sources\boost_1_70_0\bin.v2\libs\regex\build\msvc-14.1\release\address-model-64\link-static\runtime-link-static\threading-multi\libboost_regex-vc141-mt-s-x64-1_70.lib` to `C:\tmp\boostregexLib\x64\` + 5. Go in `scintilla\win32\` then run `nmake BOOSTPATH=your_boost_root_path BOOSTREGEXLIBPATH=your_built_lib_path -f scintilla.mak`. For example `nmake BOOSTPATH=C:\sources\boost_1_70_0\ BOOSTREGEXLIBPATH=C:\tmp\boostregexLib\x64\ -f scintilla.mak` + + + +## To build `SciLexer.dll` *without* boost: + +This will work with `notepad++.exe`, however some functionality in Notepad++ will be broken. + +To build SciLexer.dll without PCRE support (for both 32-bit & 64-bit): + + 1. For 32-bit, open a command prompt *for building* ([a.k.a. the *Developer Command Prompt for VS2017*](https://msdn.microsoft.com/en-us/library/f2ccy3wt.aspx)) + - From the IDE, you can do this by right clicking on a file in Solution Explorer, + and clicking "Open Command Prompt". This will open up a command prompt with all the proper environment variables. + - From the Windows Start screen/menu, type `Developer Command Prompt for VS2017`, + and click/select the result. + - From an *already open* command prompt, run `vcvarsall.bat` + (e.g. "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"). + + For 64-bit, open *VS2017 x64 Native tool command prompt*. + + 2. Change directory (`cd` or `pushd`) to `scintilla\win32\` + + 3. Build `SciLexer.dll` with one of the following commands: + - `nmake -f scintilla.mak` (normal build) + - `nmake DEBUG=1 -f scintilla.mak` (debugging build) + + 4. Copy `SciLexer.dll` from `scintilla\bin\` to the same directory as `notepad++.exe`. + - For the `Unicode Release` configuration, the output directory + (where `notepad++.exe` is) is `PowerEditor\bin\`. + - For the `Unicode Debug` configuration, the output directory + (where `notepad++.exe` is) is `PowerEditor\visual.net\Unicode Debug\`. \ No newline at end of file diff --git a/README.md b/README.md index 0c1367e5..9672dd7f 100644 --- a/README.md +++ b/README.md @@ -27,71 +27,11 @@ _Since the release of version 7.6.5 Notepad++ is signed using GPG with the follo https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/nppGpgPub.asc -To build Notepad++ from source: -------------------------------- -There are two components that need to be built separately: +Build Notepad++ +--------------- - - `notepad++.exe`: (depends on `SciLexer.dll`) - - `SciLexer.dll` : (with nmake) - -You can build Notepad++ with *or* without Boost - The release build of -Notepad++ is built **with** Boost. - -Since `Notepad++` version 6.0, the build of `SciLexer.dll` that is distributed -uses features from Boost's `Boost.Regex` library. - -You can build SciLexer.dll without Boost, ie. with its default POSIX regular -expression support instead of boost's PCRE one. This is useful if you would -like to debug Notepad++, but don't have boost. - -## To build `notepad++.exe`: - - 1. Open [`PowerEditor\visual.net\notepadPlus.vcxproj`](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/visual.net/notepadPlus.vcxproj) - 2. Build Notepad++ like a normal Visual Studio project. - - - -## To build `SciLexer.dll` with boost: - -Here are the instructions to build SciLexer.dll (for both 32-bit & 64-bit) for Notepad++: - - 1. Download the [Boost source code](https://www.boost.org/users/history/version_1_70_0.html). - 2. Unzip boost. In my case, It's unzipped in `C:\sources\boost_1_70_0` - 3. Build regex of boost. With the version 1.70, launch `bootstrap.bat` under the boost root, `b2.exe` will be generated beside of `bootstrap.bat`. For building boost PCRE lib, go into regex build directory by typing `cd C:\sources\boost_1_70_0\libs\regex\build` then launch `C:\sources\boost_1_70_0\b2.exe toolset=msvc link=static threading=multi runtime-link=static address-model=64 release stage`. - Note that **address-model=64** is optional if you want to build lib in 64 bits. For 32 bits build, just remove **address-model=64** from the command line. - 4. Copy generated message from `C:\sources\boost_1_70_0\bin.v2\libs\regex\build\msvc-14.1\release\address-model-64\link-static\runtime-link-static\threading-multi\libboost_regex-vc141-mt-s-x64-1_70.lib` to `C:\tmp\boostregexLib\x64\` - 5. Go in `scintilla\win32\` then run `nmake BOOSTPATH=your_boost_root_path BOOSTREGEXLIBPATH=your_built_lib_path -f scintilla.mak`. For example `nmake BOOSTPATH=C:\sources\boost_1_70_0\ BOOSTREGEXLIBPATH=C:\tmp\boostregexLib\x64\ -f scintilla.mak` - - - -## To build `SciLexer.dll` *without* boost: - -This will work with `notepad++.exe`, however some functionality in Notepad++ will be broken. - -To build SciLexer.dll without PCRE support (for both 32-bit & 64-bit): - - 1. For 32-bit, open a command prompt *for building* ([a.k.a. the *Developer Command Prompt for VS2017*](https://msdn.microsoft.com/en-us/library/f2ccy3wt.aspx)) - - From the IDE, you can do this by right clicking on a file in Solution Explorer, - and clicking "Open Command Prompt". This will open up a command prompt with all the proper environment variables. - - From the Windows Start screen/menu, type `Developer Command Prompt for VS2017`, - and click/select the result. - - From an *already open* command prompt, run `vcvarsall.bat` - (e.g. "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"). - - For 64-bit, open *VS2017 x64 Native tool command prompt*. - - 2. Change directory (`cd` or `pushd`) to `scintilla\win32\` - - 3. Build `SciLexer.dll` with one of the following commands: - - `nmake -f scintilla.mak` (normal build) - - `nmake DEBUG=1 -f scintilla.mak` (debugging build) - - 4. Copy `SciLexer.dll` from `scintilla\bin\` to the same directory as `notepad++.exe`. - - For the `Unicode Release` configuration, the output directory - (where `notepad++.exe` is) is `PowerEditor\bin\`. - - For the `Unicode Debug` configuration, the output directory - (where `notepad++.exe` is) is `PowerEditor\visual.net\Unicode Debug\`. +Please follow [build guide](BUILD.md) to build Notepad++ from source. Contribution