wallet/README.md

About
-----

Wallet is  open source software intended to become the manager of hierarchical
 deterministic keys for a social network that a superset of the Bitmessage social net,
 for securely pseudonymous uncensorable  public communication,
 and securely private communication. (Telegraph looks like
it will not be private for much longer).

You cannot have truly end to end encryption, except you control your own keys directly.

To make an actually useful social net requires a lot of engineers doing a lot of work, which requires funding, which requires a a profit model.  The current business plan being to [eat SWIFT's lunch](./docs/manifesto/SWIFT.html), by creating an environment in which one can create and operate the necessary Daos.

The rest of the documentation is in Pandoc markdown, rather than Gitea or Github markdown, so you will have to build it before any of these links work.

[pre alpha documentation (mostly a wish list)](docs/index.htm)

[copyright © and license](./license.txt)


Prerequisites
---------

pre-requisite, Pandoc to build the html documentation from the markdown files.

Windows pre-requisites:  Visual Studio and git-bash.  This software is supposed to be cross platform, and is unlikely to get traction with highly motivate early adopters unless it is cross platform, but currently only builds on Windows.

Download
---------

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).

```bash
# assuming Pandoc is installed, and git-bash if you are on
# windows
git clone --recurse-submodules https://gitea.rho.la/cheng/wallet.git
wallet/docs/mkdocs.sh
```

The above download relies on `https` for security, but `https` is vulnerable to enemy action by any adversary sufficiently powerful to have a certificate authority in his pocket, so our identity model relies on ssh keys, not domain names, so if you intend to make contributions, it would be preferable to create an account on `gitea.rho.la` with a fake email,
upload your ssh public key to that account, and clone using `ssh` instead of `https`

```bash
git clone --recurse-submodules gitea@gitea.rho.la:cheng/wallet.git
wallet/docs/mkdocs.sh
```

To build the docs, including the license file, you need Pandoc on the path.

```bash
cd wallet
docs/mkdocs.sh
```

Setup
------

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)

```bash
cd wallet
msvc/winConfig.bat
```

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

```bat
msvc\winConfigure.bat
```

After a pull that gives you a status of modified submodules, a to fix the submodules

```bash
git submodule update --init --recursive --remote
```

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

```bash
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

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

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

[cryptographic software is under attack]:./docs/setup/contributor_code_of_conduct.html#code-will-be-cryptographically-signed
"Contributor Code of Conduct"
{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:

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

[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.