cheng/wallet
0
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documenting that you no longer need the native tools shell

Browse Source
This commit is contained in:
aryan 2022-06-10 04:49:37 -07:00
parent 38f2edc471
commit 099965f9b3
No known key found for this signature in database
GPG Key ID: AAEB97E5E7AEDDB0
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/rootDocs/README.md
View File

@ -10,21 +10,22 @@ pre-requisite, Pandoc to build the html documentation from the markdown files.
Windows pre-requisites: Visual Studio and git-bash Windows pre-requisites: Visual Studio and git-bash
To obtain the source code from which the project can be built, including To obtain the source code from which the project can be built,
this README, from the bash command line (git-bash in windows). including this README, from the bash command line (git-bash in windows).
```bash2 ```bash2
git clone --recurse-submodules missing url git clone --recurse-submodules missing url
``` ```
To configure and build the required third party libraries in windows, then To configure and build the required third party libraries in windows,
build the program and run unit test for the first time, launch the Visual then build the program and run unit test for the first time, execute
Studio X64 native tools command prompt in the cloned directory, then:
```bat ```bat
winConfigure.bat .\winConfigure.bat
``` ```
from the windows power shell or command window.
Should the libraries change in a subsequent `pull ` you will need Should the libraries change in a subsequent `pull ` you will need
```bat ```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. should rebuild just the program, using `wallet.sln` on windows.
To rebuild the documents after editing them, `docs/mkdocs.sh` 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
`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. 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. This may be inconvenient if you do not have `gpg` installed and set up.
`.gitconfig` adds several git aliases: `.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 For this to be useful you need to import the repository public key
`public_key.gpg` into gpg, and locally sign that key. `public_key.gpg` into gpg, and locally sign that key.
1. `git graph` to graph the commit tree with signing status 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 has been installed, you should be able to run this shell
file in bash by double clicking on it. 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 [Pre alpha release](./RELEASE_NOTES.html), which means it does not yet work even well
it to be apparent what it would do if it did work. enough for it to be apparent what it would do if it did work.