diff --git a/.gitattributes b/.gitattributes index 3c93bcf..0833179 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,23 +4,23 @@ # Force the following filetypes to have unix eols and encoding, so that Windows does not break them. # If a file is going to be used on linux and windows, we want it invariant, # rather than automatically translated, because automatic translation always screw things up. -* text=auto eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -.gitignore text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -.gitattributes text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -.gitmodules text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -*.sh text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=bash -*.c text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -*.cpp text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=cpp -*.rs text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=rust -*.py text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=python -*.h text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -*.txt text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -*.html text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=html -*.htm text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=html -*.md text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=markdown -*.pandoc text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -*.css text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=css -*.manifest text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +* text=auto eol=lf encoding=utf-8, whitespace=trailing-space,space-before-tab,tabwidth=4 +.gitignore text eol=lf encoding=utf-8, whitespace=trailing-space,space-before-tab,tabwidth=4 +.gitattributes text eol=lf encoding=utf-8, whitespace=trailing-space,space-before-tab,tabwidth=4 +.gitmodules text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +*.sh text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=bash +*.c text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +*.cpp text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=cpp +*.rs text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=rust +*.py text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=python +*.h text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +*.txt text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +*.html text eol=lf encoding=utf-8 whitespace=space-before-tab,tabwidth=4 diff=html +*.htm text eol=lf encoding=utf-8 whitespace=space-before-tab,tabwidth=4 diff=html +*.md text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=markdown +*.pandoc text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 +*.css text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 diff=css +*.manifest text eol=lf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 makefile text eol=lf encoding=utf-8 diff --git a/README.html b/README.html new file mode 100644 index 0000000..acfae94 --- /dev/null +++ b/README.html @@ -0,0 +1,158 @@ + + +
+ + + +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.
+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 keygit graph
to graph the commit tree with the committer name from .gitsigners
that corresponds to the public keygit 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.
+ reaction.la gpg key 154588427F2709CD9D7146B01C99BB982002C39F
This work is licensed under the Creative Commons Attribution 4.0 International License.
To build and run README
+pre alpha documentation (mostly a wish list) (In order to read these on this local system, you must first execute the document build script mkdocs.sh
, with bash
, sed
and pandoc
)
This software is pre alpha and should not yet be released. It does +not work well enough to even show what it would do if it was +working
+ reaction.la gpg key 154588427F2709CD9D7146B01C99BB982002C39F
This work is licensed under the Creative Commons Attribution 4.0 International License.