From 099965f9b3dca35eb2d30649d49b13f67eccec5f Mon Sep 17 00:00:00 2001 From: aryan Date: Fri, 10 Jun 2022 04:49:37 -0700 Subject: [PATCH] documenting that you no longer need the native tools shell --- docs/rootDocs/README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/rootDocs/README.md b/docs/rootDocs/README.md index 199de43..fefb93a 100644 --- a/docs/rootDocs/README.md +++ b/docs/rootDocs/README.md @@ -10,21 +10,22 @@ pre-requisite, Pandoc to build the html documentation from the markdown files. Windows pre-requisites: Visual Studio and git-bash -To obtain the source code from which the project can be built, including -this README, from the bash command line (git-bash in windows). +To obtain the source code from which the project can be built, +including this README, from the bash command line (git-bash in windows). ```bash2 git clone --recurse-submodules missing url ``` -To configure and build the required third party libraries in windows, then -build the program and run unit test for the first time, launch the Visual -Studio X64 native tools command prompt in the cloned directory, then: +To configure and build the required third party libraries in windows, +then build the program and run unit test for the first time, execute ```bat -winConfigure.bat +.\winConfigure.bat ``` +from the windows power shell or command window. + Should the libraries change in a subsequent `pull ` you will need ```bat @@ -48,14 +49,16 @@ takes a while. Normally when you make changes to the source code you should rebuild just the program, using `wallet.sln` on windows. To rebuild the documents after editing them, `docs/mkdocs.sh` -winConfigure.bat also configures the repository you just created to use -`winConfigure.bat` also configures the repository you just created to use `.gitconfig` in the repository, causing git to to implement GPG signed commits -- because [cryptographic software is under attack] from NSA entryists and shills, who seek to introduce backdoors. +winConfigure.bat also configures the repository you just created to +to use `.gitconfig` in the repository, causing git to to implement +GPG signed commits -- because [cryptographic software is under attack] +from NSA entryists and shills, who seek to introduce backdoors. This may be inconvenient if you do not have `gpg` installed and set up. `.gitconfig` adds several git aliases: -1. `git lg` to display the gpg trust information for the last four commits. +1. `git lg` to display the gpg trust information for the last few commits. For this to be useful you need to import the repository public key `public_key.gpg` into gpg, and locally sign that key. 1. `git graph` to graph the commit tree with signing status @@ -93,5 +96,5 @@ files, execute the bash script file `docs/mkdocs.sh`, in an environment where has been installed, you should be able to run this shell file in bash by double clicking on it. -[Pre alpha release](./RELEASE_NOTES.html), which means it does not yet work even well enough for -it to be apparent what it would do if it did work. +[Pre alpha release](./RELEASE_NOTES.html), which means it does not yet work even well +enough for it to be apparent what it would do if it did work.