From 5823526630b803ce7b410063e7df5763956f1e65 Mon Sep 17 00:00:00 2001 From: "reaction.la" Date: Wed, 28 Aug 2024 09:57:19 +0000 Subject: [PATCH] creating a README in accordance with Github and Gitea standards --- README.html | 158 ---------------------- docs/rootDocs/README.md => README.md | 64 ++++++--- docs/setup/contributor_code_of_conduct.md | 38 +----- 3 files changed, 49 insertions(+), 211 deletions(-) delete mode 100644 README.html rename docs/rootDocs/README.md => README.md (54%) diff --git a/README.html b/README.html deleted file mode 100644 index acfae94..0000000 --- a/README.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - README - - - - - - - -
- - logo -
-
- -
-
- readme - license - notice - release notes -
-
-

README

-

pre alpha documentation (mostly a wish list)

-

copyright © and license

-

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:

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

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.

-

Creative Commons License reaction.la gpg key 154588427F2709CD9D7146B01C99BB982002C39F
This work is licensed under the Creative Commons Attribution 4.0 International License.

- - diff --git a/docs/rootDocs/README.md b/README.md similarity index 54% rename from docs/rootDocs/README.md rename to README.md index c860dcc..d81f3ca 100644 --- a/docs/rootDocs/README.md +++ b/README.md @@ -1,51 +1,77 @@ ---- -title: >- - README ---- +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 +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 -git clone --recurse-submodules missing url +# 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 ``` -To build the docs, you need pandoc on the path. +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` -```bash2 -cd wallet/docs -./mkdocs.sh +```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) -```bash2 +```bash cd wallet -./winConfigure.bat +msvc/winConfig.bat ``` Or, if you are in the command shell or power shell, ```bat -.\winConfigure.bat +msvc\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. +After a pull that gives you a status of modified submodules, a to fix the submodules ```bash git submodule update --init --recursive --remote diff --git a/docs/setup/contributor_code_of_conduct.md b/docs/setup/contributor_code_of_conduct.md index c7016a2..d710bc3 100644 --- a/docs/setup/contributor_code_of_conduct.md +++ b/docs/setup/contributor_code_of_conduct.md @@ -131,7 +131,7 @@ identified cryptographically, rather than through the domain name system. then at the root of your repository ```bash -ssh-keygen -t ed25519 -f .git/gandalf #to create your key pair +ssh-keygen -t ed25519 - C gandalf -f .git/gandalf #to create your key pair git config user.signingkey .git/gandalf.pub #tell git to use this key pair git config user.name gandalf #will be ignored git config user.email gandalf@ #fake email will be ignored @@ -146,7 +146,7 @@ git config include.path ../.gitconfig #sets various defaults, ssh signing among displayed by the git aliases of `.gitconfig` The nym in `.gitsigners` is the one that matters, though `user.email` - and `user.name` should be the same or sufficiently similar to + and `user.name` should be the same or sufficiently related to show you are not up to anything funny. # No race, sex, religion, nationality, or sexual preference @@ -242,47 +242,17 @@ attempts to develop software is going to survive. Linux is a dead man walking. # Style -Contributions should be gpg signed. - -Never use any email address on a gpg key related to this project -unless it is only used for project purposes, or a fake email, or the -email of an enemy. We don't want Gpg used to link different email -addresses as owned by the same entity, and we don't want email -addresses used to link people to the project, because those -identities would then come under state and quasi state pressure. - -if you add the recommended repository configuration defaults to your local repository configuration - -```bash -git config --local include.path ../.gitconfig -``` - -This will implement signed commits and will insist that you have `gpg` on your path, -and that you have configured a signing key in your local config. - -This may be inconvenient if you do not have `gpg` installed and set up. - `.gitconfig` adds several git aliases: 1. `git utcmt` to do a commit without recording your timezone in the git history -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 `‑‑lsign` that key. +1. `git lg` to display the .gitsigner trust information for the last few commits. 1. `git graph` to graph the commit tree with signing status 1. `git alias` to display the git aliases. -To only pull signed commits from people you have listed: - -```bash -git config merge.verifySignatures true -gpg --import public_key.gpg -gpg --lsign 096EAE16FB8D62E75D243199BC4482E49673711C -``` - We ignore the Gpg Web of Trust model, and instead use the Zooko identity model. -We use Gpg signatures to verify that remote repository code +We use ssh signatures to verify that remote repository code is coming from an unchanging entity, not for Gpg Web of Trust. Web of Trust is too complicated and too user hostile to be workable or safe. No one ever used it in the intended manner.