wallet

History

reaction.la 6d4fb43622 two versions of README.md, one github markdown, and one pandoc markdown		2024-08-28 19:20:36 +08:00
..
icon.pandoc	fixing automatic doc generation	2022-07-07 08:48:08 +10:00
LICENSE.md	moved markdown files from root directory	2022-05-20 21:44:46 +10:00
mkdocs.sh	modified: docs/estimating_frequencies_from_small_samples.md	2024-06-28 15:52:41 +08:00
navbar	Due to massive violation of the dry principle, I broke all the navbars	2024-05-09 16:39:22 +08:00
NOTICE.md	structuring this random pile of documents	2022-07-25 02:16:45 -07:00
README.md	two versions of README.md, one github markdown, and one pandoc markdown	2024-08-28 19:20:36 +08:00
RELEASE_NOTES.md	Merge remote-tracking branch 'origin/docs'	2022-05-22 19:42:36 +10:00

README.md

title
README

pre alpha documentation (mostly a wish list)

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.html, from the bash command line (git-bash in windows).

git clone --recurse-submodules missing url

To build the docs, you need pandoc on the path.

cd wallet/docs
./mkdocs.sh

To configure and build the required third party libraries in windows, then build the program and run unit test for the first time, you need to have Visual studio build tools at their default location)

cd wallet
./winConfigure.bat

Or, if you are in the command shell or power shell,

.\winConfigure.bat

After a pull from remote in which the submodules have changed, the pull fails to automatically update the submodules by default, and when you switch or checkout branches, the switch fails to automatically switch and checkout the brances.

After a pull that gives you a status of modified submodules.

git submodule update --init --recursive --remote

After a checkout or branch switch that gives you a status of modified submodules.

git submodule update --recursive

The documentation is in pandoc flavored markdown, which is conveniently edited in vscode with the markdown lint and Pandoc extensions included and, if you have launched code in the docs directory, with file/preferences/Extensions/Markdown/Styles set to pandoc_templates\\style.css, that being the style used by the mkdocs.sh documentation build script.

On Windows, if Git Bash and Pandoc has been installed, you should be able to run this shell file in bash by double clicking on it.

if you add the recommended repository configuration defaults to your local repository configuration

git config --local include.path ../.gitconfig

this will substantially mitigate the problem of submodules failing to update in pushes, pulls, checkouts, and switches.

{target="_blank"}

It will, however, also implement signed commits, and insist you have set up a key pair as explained in the contributor code of conduct because cryptographic software is under attack from NSA entryists and shills, who seek to introduce backdoors.

.gitconfig also adds several git aliases:

git lg to display the git log with committer name from .gitsigners that corresponds to the public key
git graph to graph the commit tree with the committer name from .gitsigners that corresponds to the public key
git alias to display the git aliases.
git utcmt to make a commit without revealing your time zone.

Pre alpha release, which means it does not yet work even well enough for it to be apparent what it would do if it did work.