[Docs] Added NSIS install steps to build-windows.md #14744

pull LucianaMarques wants to merge 3 commits into bitcoin:master from LucianaMarques:windows-doc changing 1 files +11 −0

LucianaMarques commented at 1:00 PM on November 17, 2018: contributor

This pull request is intended to close #14699

I never built for Windows, so I'm not sure if the instructions I added are correct, please give me feedback on it.

Thank you!
added nsis install steps to windows docs 56c8b3e4f3
fanquake added the label Docs on Nov 17, 2018

in doc/build-windows.md:78 in 56c8b3e4f3 outdated

  73 | +have [NSIS](https://nsis.sourceforge.io/Main_Page) installed.
  74 | +
  75 | +```
  76 | +sudo apt install nsis
  77 | +make deploy
  78 | +makensis share/setup.nsi

ken2812221 commented at 1:05 PM on November 17, 2018:

makensis share/setup.nsi is not necessary

in doc/build-windows.md:72 in 56c8b3e4f3 outdated
```
  66 | @@ -67,6 +67,17 @@ build process.
  67 |  
  68 |  See also: [dependencies.md](dependencies.md).
  69 |  
  70 | +## Install NSIS
  71 | +
  72 | +The following steps are necessary to create the binary file. In order to create it, the system must
```
fanquake commented at 2:19 PM on November 17, 2018:

s/binary file/binary installer

LucianaMarques commented at 3:53 PM on November 17, 2018:

I didn't understand your comment. Should I replace 'binary file' to 'binary installer', or the commands in the terminal should run in 's/binary file/binary installer/' directory?

fanquake commented at 6:52 AM on November 19, 2018:

You should replace binary file with binary installer
fanquake commented at 2:20 PM on November 17, 2018: member

I'd suggest moving this down between the Depends and Installation sections of the build doc. Someone is not going to be able to run make deploy unless that have already completed the steps for a 32/64 bit build.
ken2812221 changes_requested
LucianaMarques commented at 3:53 PM on November 17, 2018: contributor

I'd suggest moving this down between the Depends and Installation sections of the build doc. Someone is not going to be able to run make deploy unless that have already completed the steps for a 32/64 bit build.

Done!
moved the NSIS section to between Depends and Installation 5f43824146
in doc/build-windows.md:132 in 5f43824146 outdated
```
 128 | @@ -129,6 +129,17 @@ Then build using:
 129 |  
 130 |  For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
 131 |  
 132 | +## Install NSIS
```
fanquake commented at 6:53 AM on November 19, 2018:

Can you change the title to be something like "Create Installer", and use the dash title method i.e ------ below the words (the same as all the rest of the titles in this document).

laanwj commented at 7:19 PM on November 19, 2018:

well the depends system above it also uses ##, it's inconsistent with the rest of the document that's true

LucianaMarques commented at 11:53 PM on November 19, 2018:

I guess I see @fanquake 's logic. Done.
laanwj commented at 7:25 PM on November 19, 2018: member

The last step (calling makensis manually) should not be necessary. configure.ac has logic to find makensis, you'll need to install it before calling ./configure for that:

https://github.com/bitcoin/bitcoin/blob/master/configure.ac#L470

Then, make deploy will generate the installer for you:

https://github.com/bitcoin/bitcoin/blob/master/Makefile.am#L73

(see, for example, how the gitian build script works: https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-descriptors/gitian-win.yml#L157)
LucianaMarques commented at 11:54 PM on November 19, 2018: contributor

The last step (calling makensis manually) should not be necessary. configure.ac has logic to find makensis, you'll need to install it before calling ./configure for that:

https://github.com/bitcoin/bitcoin/blob/master/configure.ac#L470

Then, make deploy will generate the installer for you:

https://github.com/bitcoin/bitcoin/blob/master/Makefile.am#L73

(see, for example, how the gitian build script works: https://github.com/bitcoin/bitcoin/blob/master/contrib/gitian-descriptors/gitian-win.yml#L157)

Thank you very much for the explanation!
Changed NSIS section's title and excluded last step 990f37a68c

in doc/build-windows.md:136 in 990f37a68c

 128 | @@ -129,6 +129,17 @@ Then build using:
 129 |  
 130 |  For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
 131 |  
 132 | +Create installer
 133 | +-----------------
 134 | +
 135 | +The following steps are necessary to create the binary installer. In order to create it, the system must
 136 | +have [NSIS](https://nsis.sourceforge.io/Main_Page) installed.

laanwj commented at 7:29 AM on November 23, 2018:

I think you should mention that it should be installed before running ./configure, if you install it just before the make step in the steps below it's not going to work.

fanquake commented at 2:55 PM on December 13, 2018: member

@LucianaMarques Thanks for your work here. I've picked this up in #14950. The changes are still attributed to you.
fanquake closed this on Dec 13, 2018
MarcoFalke referenced this in commit b545a7e337 on Dec 18, 2018
DrahtBot locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#14699 docs: Windows build docs are missing `make deploy` #14950 docs: add NSIS setup/install steps to windows docs