Go to file
2022-06-12 17:38:26 +10:00
docs documenting my sufferings with git submodules 2022-06-11 21:34:51 +10:00
libsodium@012e892841 figured it out. Git ignores submodules unless they are in detached head mode 2022-06-11 15:12:52 +10:00
mpir@7e09c025f6 added the repos fresh, I hope 2022-06-11 14:20:20 +10:00
nmake cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
sqlite3 Updated sqlite3 preparatory to adding the submodule wxSwlite3 2022-05-08 12:17:46 +10:00
wxWidgets@57e4e5d705 figured it out. Git ignores submodules unless they are in detached head mode 2022-06-11 15:12:52 +10:00
.gitattributes whitespace woes 2022-05-23 14:05:10 +10:00
.gitconfig documenting my sufferings with git submodules 2022-06-11 21:34:51 +10:00
.gitignore whitespace woes 2022-05-23 14:05:10 +10:00
.gitmodules added the repos fresh, I hope 2022-06-11 14:20:20 +10:00
app.cpp Now UI is working well enough to finally introduce secret management 2022-05-22 19:36:23 +10:00
app.h Spent far too much time fixing <=> to operate over ranges 2022-02-23 19:21:31 +10:00
db_accessors.h spent far too much time getting compile time code to work. 2022-06-12 17:38:26 +10:00
display_wallet.cpp minor layout 2022-05-23 16:06:01 +10:00
display_wallet.h Now UI is working well enough to finally introduce secret management 2022-05-22 19:36:23 +10:00
frame.cpp minor layout 2022-05-23 16:06:01 +10:00
frame.h minor layout 2022-05-23 16:06:01 +10:00
Icon.ico leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
ILog.cpp cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
ILog.h leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
introspection_of_standard_C_types.h minor layout 2022-05-23 16:06:01 +10:00
ISqlit3Impl.cpp Updated sqlite3 preparatory to adding the submodule wxSwlite3 2022-05-08 12:17:46 +10:00
ISqlite3.h cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
LICENSE.html moved markdown files from root directory 2022-05-20 21:44:46 +10:00
localization.cpp Now UI is working well enough to finally introduce secret management 2022-05-22 19:36:23 +10:00
localization.h minor layout 2022-05-23 16:06:01 +10:00
mpir_and_base58.cpp spent far too much time getting compile time code to work. 2022-06-12 17:38:26 +10:00
mpir_and_base58.h Restructuring to allow child pages access to frame menus 2022-03-08 14:46:14 +10:00
NOTICE.html moved markdown files from root directory 2022-05-20 21:44:46 +10:00
public_key.gpg leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
README.html moved markdown files from root directory 2022-05-20 21:44:46 +10:00
RELEASE_NOTES.html moved markdown files from root directory 2022-05-20 21:44:46 +10:00
rho.ico leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
rho.xpm leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
ristretto255.cpp minor layout 2022-05-23 16:06:01 +10:00
ristretto255.h minor layout 2022-05-23 16:06:01 +10:00
rotime.cpp cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
rotime.h Restructuring to allow child pages access to frame menus 2022-03-08 14:46:14 +10:00
secrets.cpp leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
secrets.h cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
slash6.cpp spent far too much time getting compile time code to work. 2022-06-12 17:38:26 +10:00
slash6.h Restructuring to allow child pages access to frame menus 2022-03-08 14:46:14 +10:00
stdafx.cpp leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
stdafx.h updated to widgets 3.1.7 2022-06-10 16:31:33 +10:00
testbed.cpp spent far too much time getting compile time code to work. 2022-06-12 17:38:26 +10:00
tobedone.txt cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
unit_test.cpp Now UI is working well enough to finally introduce secret management 2022-05-22 19:36:23 +10:00
wallet.manifest leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
wallet.rc cleanup, and just do not like pdfs 2022-02-20 18:26:44 +10:00
wallet.sln leaving potentially inconvenient history behind 2022-02-16 15:54:47 +10:00
wallet.vcxproj Updated sqlite3 preparatory to adding the submodule wxSwlite3 2022-05-08 12:17:46 +10:00
welcome_to_rhocoin.cpp Fixing window switches within the frame 2022-04-03 12:07:41 +10:00
welcome_to_rhocoin.h Fixing window switches within the frame 2022-04-03 12:07:41 +10:00
winConfigure.bat updating wxWidgets to 3.1.6 2022-05-05 12:10:41 +10:00
winConfigure.sh winConfigure.sh fixed, yet again 2022-05-12 06:39:45 +10:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>README</title>
  <style>
    code{white-space: pre-wrap;}
    span.smallcaps{font-variant: small-caps;}
    span.underline{text-decoration: underline;}
    div.column{display: inline-block; vertical-align: top; width: 50%;}
    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
    ul.task-list{list-style: none;}
    pre > code.sourceCode { white-space: pre; position: relative; }
    pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
    pre > code.sourceCode > span:empty { height: 1.2em; }
    .sourceCode { overflow: visible; }
    code.sourceCode > span { color: inherit; text-decoration: inherit; }
    div.sourceCode { margin: 1em 0; }
    pre.sourceCode { margin: 0; }
    @media screen {
    div.sourceCode { overflow: auto; }
    }
    @media print {
    pre > code.sourceCode { white-space: pre-wrap; }
    pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
    }
    pre.numberSource code
      { counter-reset: source-line 0; }
    pre.numberSource code > span
      { position: relative; left: -4em; counter-increment: source-line; }
    pre.numberSource code > span > a:first-child::before
      { content: counter(source-line);
        position: relative; left: -1em; text-align: right; vertical-align: baseline;
        border: none; display: inline-block;
        -webkit-touch-callout: none; -webkit-user-select: none;
        -khtml-user-select: none; -moz-user-select: none;
        -ms-user-select: none; user-select: none;
        padding: 0 4px; width: 4em;
        color: #aaaaaa;
      }
    pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa;  padding-left: 4px; }
    div.sourceCode
      {   }
    @media screen {
    pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
    }
    code span.al { color: #ff0000; font-weight: bold; } /* Alert */
    code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
    code span.at { color: #7d9029; } /* Attribute */
    code span.bn { color: #40a070; } /* BaseN */
    code span.bu { } /* BuiltIn */
    code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
    code span.ch { color: #4070a0; } /* Char */
    code span.cn { color: #880000; } /* Constant */
    code span.co { color: #60a0b0; font-style: italic; } /* Comment */
    code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
    code span.do { color: #ba2121; font-style: italic; } /* Documentation */
    code span.dt { color: #902000; } /* DataType */
    code span.dv { color: #40a070; } /* DecVal */
    code span.er { color: #ff0000; font-weight: bold; } /* Error */
    code span.ex { } /* Extension */
    code span.fl { color: #40a070; } /* Float */
    code span.fu { color: #06287e; } /* Function */
    code span.im { } /* Import */
    code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
    code span.kw { color: #007020; font-weight: bold; } /* Keyword */
    code span.op { color: #666666; } /* Operator */
    code span.ot { color: #007020; } /* Other */
    code span.pp { color: #bc7a00; } /* Preprocessor */
    code span.sc { color: #4070a0; } /* SpecialChar */
    code span.ss { color: #bb6688; } /* SpecialString */
    code span.st { color: #4070a0; } /* String */
    code span.va { color: #19177c; } /* Variable */
    code span.vs { color: #4070a0; } /* VerbatimString */
    code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
  </style>
  <style type="text/css">body {
max-width: 30em;
margin-left: 1em;
}
table {
border-collapse: collapse;
}
td, th {
border: 1px solid #999;
padding: 0.5rem;
text-align: left;
}
code{white-space: pre-wrap;
}
span.smallcaps{font-variant: small-caps;
}
span.underline{text-decoration: underline;
}
div.column{display: inline-block; vertical-align: top; width: 50%;
}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;
}
ul.task-list{list-style: none;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;
}
h1.title{text-align: center; font-size: xxx-large;
}
div.center {text-align:center;
}
div.centre {text-align:center;
}
table {
border-collapse: collapse;
}
td, th {
border: 1px solid #999;
padding: 0.5rem;
text-align: left;
}
</style>
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">README</h1>
</header>
<p><a href="docs/index.htm">pre alpha documentation (mostly a wish list)</a></p>
<p><a href="./license.txt">copyright © and license</a></p>
<p>pre-requisite, Pandoc to build the html documentation from the markdown files.</p>
<p>Windows pre-requisites: Visual Studio and git-bash</p>
<p>To obtain the source code from which the project can be built, including
this README, from the bash command line (git-bash in windows).</p>
<pre class="bash2"><code>git clone --recurse-submodules missing url</code></pre>
<p>To configure and build the required third party libraries in windows, then
build the program and run unit test for the first time, launch the Visual
Studio X64 native tools command prompt in the cloned directory, then:</p>
<pre class="bat"><code>winConfigure.bat</code></pre>
<p>Should the libraries change in a subsequent <code>pull</code> you will need</p>
<pre class="bat"><code>pull -f --recurse-submodules
winConfigure.bat</code></pre>
<p>winConfigure.bat also configures the repository you just created to use
<code>.gitconfig</code> in the repository, causing git to to implement GPG signed
commits  because <a href="./docs/contributor_code_of_conduct.html#code-will-be-cryptographically-signed" target="_blank" title="Contributor Code of Conduct">cryptographic software is under attack</a> from NSA
entryists, and shills, who seek to introduce backdoors.</p>
<p>This may be inconvenient if you do not have <code>gpg</code> installed and set up.</p>
<p><code>.gitconfig</code> adds several git aliases:</p>
<ol type="1">
<li><code>git lg</code> to display the gpg trust information for the last four commits.
For this to be useful you need to import the repository public key
<code>public_key.gpg</code> into gpg, and locally sign that key.</li>
<li><code>git fixws</code> to standardise white space to the project standards</li>
<li><code>git graph</code> to graph the commit tree</li>
<li><code>git alias</code> to display the git aliases.</li>
</ol>
<div class="sourceCode" id="cb4"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="co"># To verify that the signature on future pulls is unchanged.</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg</span> <span class="at">--import</span>  public_key.gpg</span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="ex">gpg</span> <span class="at">--lsign</span> 096EAE16FB8D62E75D243199BC4482E49673711C</span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="co"># We ignore the Gpg Web of Trust model and instead use</span></span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="co"># the Zooko identity model.</span></span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a><span class="co"># We use Gpg signatures to verify that remote repository</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="co"># code is coming from an unchanging entity, not for</span></span>
<span id="cb4-8"><a href="#cb4-8" aria-hidden="true" tabindex="-1"></a><span class="co"># Gpg Web of Trust.  Web of Trust is too complicated</span></span>
<span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a><span class="co"># and too user hostile to be workable or safe.</span></span>
<span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a><span class="co"># Never --sign any Gpg key related to this project.  --lsign it.</span></span>
<span id="cb4-11"><a href="#cb4-11" aria-hidden="true" tabindex="-1"></a><span class="co"># Never check any Gpg key related to this project against a</span></span>
<span id="cb4-12"><a href="#cb4-12" aria-hidden="true" tabindex="-1"></a><span class="co"># public gpg key repository. It should not be there.</span></span>
<span id="cb4-13"><a href="#cb4-13" aria-hidden="true" tabindex="-1"></a><span class="co"># Never use any email address on a gpg key related to this project</span></span>
<span id="cb4-14"><a href="#cb4-14" aria-hidden="true" tabindex="-1"></a><span class="co"># unless it is only used for project purposes, or a fake email,</span></span>
<span id="cb4-15"><a href="#cb4-15" aria-hidden="true" tabindex="-1"></a><span class="co"># or the email of an enemy.</span></span></code></pre></div>
<p>To build the documentation in its intended html form from the markdown
files, execute the bash script file <code>docs/mkdocs.sh</code>, in an environment where
<code>pandoc</code> is available. On Windows, if Git Bash and Pandoc has been
installed, you should be able to run a shell file in bash by double clicking on it.</p>
<p><a href="./RELEASE_NOTES.html">Pre alpha release</a>, which means it does not yet work even well enough for
it to be apparent what it would do if it did work.</p>
</body>
</html>