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

still fixing README, so that the github markdown README looks like the Pandoc markdown README.

Browse Source
This commit is contained in:
reaction.la 2024-08-29 07:52:59 +00:00
parent 7f59262175
commit 462d436039
No known key found for this signature in database
2 changed files with 47 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,5 +1,6 @@
About
-----
#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,
@ -10,29 +11,26 @@ 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.
which requires funding, which requires 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.
We need uncensorable speech to save civilisation, but uncensorable speech does not pay the bills.
Uncensorable money does pay the bills.
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)
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.
[copyright © and license](./license.txt)
Prerequisites
---------
## 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
---------
## 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).
@ -47,6 +45,9 @@ 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`
Fork the repository and provide a comment explaining the fork, otherwise your
login might be deleted as spam.
```bash
git clone --recurse-submodules gitea@gitea.rho.la:cheng/wallet.git
wallet/docs/mkdocs.sh
@ -59,8 +60,7 @@ cd wallet
docs/mkdocs.sh
```
Setup
------
## 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
@ -77,7 +77,7 @@ Or, if you are in the command shell or power shell,
msvc\winConfigure.bat
```
After a pull that gives you a status of modified submodules, a to fix the submodules
After a pull that gives you a status of modified submodules, to fix the submodules
```bash
git submodule update --init --recursive --remote

54
docs/rootDocs/README.md
View File

@ -3,7 +3,7 @@ title: >-
README
---
## About
# 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,
@ -14,58 +14,72 @@ 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.
which requires funding, which requires 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.
We need uncensorable speech to save civilisation, but uncensorable speech does not pay the bills.
Uncensorable money does pay the bills.
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.
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){target="_blank"}
[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
Fork the repository and provide a comment explaining the fork, otherwise your
login might be deleted as spam.
```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, to fix the submodules
```bash
git submodule update --init --recursive --remote