-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
188 lines (185 loc) · 9.69 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<html>
<head>
<title>Hebrew Pi</title>
</head>
<body>
<p><a href="LICENSE"><img src="https://img.shields.io/github/license/ordisoftware/hebrew-calendar" alt="License MPL 2.0" /></a>
<a href="https://github.com/Ordisoftware/Hebrew-Calendar/releases"><img src="https://img.shields.io/github/downloads/ordisoftware/hebrew-calendar/total" alt="GitHub all releases downloads" /></a>
<a href="https://github.com/Ordisoftware/Hebrew-Calendar/releases/latest"><img src="https://img.shields.io/github/v/release/ordisoftware/hebrew-calendar" alt="GitHub release (latest by date)" /></a>
<a href="#"><img src="https://img.shields.io/github/repo-size/ordisoftware/hebrew-calendar" alt="GitHub repo size" /></a>
<a href="https://github.com/Ordisoftware/Hebrew-Calendar/tree/main/Project"><img src="https://img.shields.io/github/languages/code-size/ordisoftware/hebrew-calendar" alt="GitHub code size in bytes" /></a>
<a href="https://github.com/Ordisoftware/Hebrew-Calendar/tree/main/Project"><img src="https://img.shields.io/tokei/lines/github/ordisoftware/hebrew-calendar" alt="Lines of code" /></a> <br/>
<a href="https://www.microsoft.com/windows/"><img src="https://img.shields.io/badge/Windows%2010%2B-279CE8?label=os" alt="OS: Windows" /></a>
<a href="https://github.com/dotnet/winforms"><img src="https://img.shields.io/badge/WinForms-279CE8?label=ui" alt="UI: WinForms" /></a>
<a href="https://dotnet.microsoft.com"><img src="https://img.shields.io/badge/.NET%204.8.1-6E5FA6?label=framework" alt="Framework: .Net" /></a>
<a href="https://visualstudio.microsoft.com"><img src="https://img.shields.io/badge/Visual%20Studio%202022-6E5FA6.svg?label=ide" alt="IDE: Visual Studio" /></a>
<a href="https://docs.microsoft.com/dotnet/csharp/"><img src="https://img.shields.io/badge/C%23%2012-%23239120.svg?label=lang" alt="Lang: C#" /></a>
<a href="https://www.sqlite.org"><img src="https://img.shields.io/badge/SQLite%203.46-darkgoldenrod.svg?label=db" alt="DB: SQLite" /></a> <br/>
<a href="https://www.ordisoftware.com/hebrew-calendar"><img src="https://img.shields.io/badge/-Ordisoftware.com%20Project-355F90?logo=WordPress&logoColor=white" alt="Ordisoftware.com Project" /></a>
<a href="https://github.com/Ordisoftware/Guidelines"><img src="https://img.shields.io/badge/-Manufacturing%20Software%20Guidelines-355F90?logo=MicrosoftWord&logoColor=white" alt="Manufacturing Software Guidelines" /></a> </p>
<h1 id="hebrew-pi">Hebrew Pi</h1>
<p>A libre and open-source software written in C# that allows decoding decimal sequences of Pi into meaningful sentences, by interpreting each motif of 10 digits as a representation of Hebrew letters using linguistic patterns through the principles of Gematria and Kabbalah.</p>
<h2 id="table-of-content">Table of content</h2>
<ol>
<li><a href="#functionalities">Functionalities</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#download">Download</a></li>
<li><a href="#screenshots">Screenshots</a></li>
<li><a href="#system-frequently-asked-questions">System FAQ</a></li>
<li><a href="#application-frequently-asked-questions">Application FAQ</a></li>
<li><a href="#command-line-options">Command-line options</a></li>
<li><a href="#keyboard-shortcuts">Keyboard shortcuts</a></li>
<li><a href="#future-improvements">Future improvements</a></li>
<li><a href="#changelog">Changelog</a></li>
</ol>
<h2 id="functionalities">Functionalities</h2>
<ul>
<li>Import Pi decimals from text file.</li>
<li>Reduce repetitions: loop to add the position until none remain or there is more.</li>
<li>Links to various online resources.</li>
<li>English, French.</li>
</ul>
<h2 id="requirements">Requirements</h2>
<ul>
<li>Screen 1024x768 or higher</li>
<li>Windows 10 x32/x64 or higher</li>
<li>Framework .NET 4.8.1</li>
<li>SQLite 3.46.1</li>
</ul>
<h2 id="download">Download</h2>
<p><strong>What's new in the latest version</strong></p>
<p><a href="https://github.com/Ordisoftware/Hebrew-Pi/releases/latest">Last release</a></p>
<h2 id="screenshots">Screenshots</h2>
<h2 id="system-frequently-asked-questions">System Frequently asked questions</h2>
<h4 id="what-code-analyzers-are-used-in-addition-to-visual-studio">What code analyzers are used in addition to Visual Studio?</h4>
<table>
<thead>
<tr>
<th>IDE Extension</th>
<th>Project NuGet</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://marketplace.visualstudio.com/items?itemName=SonarSource.SonarLintforVisualStudio2022">SonarLint</a><br><a href="https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022">Roslynator</a><br><a href="https://marketplace.visualstudio.com/items?itemName=Flash0Ware.F0-Analyzers-VS">F0.Analyzers</a><br><a href="https://marketplace.visualstudio.com/items?itemName=camrein.ParallelHelper">Parallel Helper</a><br><a href="https://marketplace.visualstudio.com/items?itemName=LBHSR.ParallelChecker">Parallel Checker</a><br><a href="https://marketplace.visualstudio.com/items?itemName=SemihOkur.AsyncFixer2022">AsyncFixer</a><br><a href="https://marketplace.visualstudio.com/items?itemName=PRIYANSHUAGRAWAL92.AsyncMethodNameFixer">Async Method Name Fixer</a><br><a href="https://marketplace.visualstudio.com/items?itemName=vs-publisher-363830.U2UConsultPerformanceCodeAnalyzersforC7">U2U Consult Performance Analyzers</a><br><a href="https://github.com/Zefek/TSQLAnalyzer">TSQL Analyzer</a><br><a href="https://github.com/Suchiman/SerilogAnalyzer">Serilog Analyzer</a><br><a href="https://marketplace.visualstudio.com/items?itemName=JaroslavLobacevski.SecurityCodeScanVS2019">Security Code Scan</a><br><a href="https://marketplace.visualstudio.com/items?itemName=PumaSecurity.PumaScan">Puma Scan</a><br><a href="https://github.com/Vannevelj/SharpSource">SharpSource</a><br><a href="https://github.com/microsoft/InclusivenessAnalyzerVisualStudio">Inclusiveness Analyzer</a></td>
<td><a href="https://github.com/dotnet/roslyn-analyzers">Microsoft.CodeAnalysis.NetAnalyzers</a><br><a href="https://github.com/microsoft/vs-threading">Microsoft.VisualStudio.Threading.Analyzers</a><br><a href="https://github.com/cezarypiatek/MultithreadingAnalyzer">MultithreadingAnalyzer</a><br><a href="https://github.com/meziantou/Meziantou.Analyzer">Meziantou.Analyzer</a><br><a href="https://github.com/Geeksltd/GCop">GCop.All.Common</a><br><a href="https://github.com/DotNetAnalyzers/ReflectionAnalyzers">ReflectionAnalyzers</a><br><a href="https://github.com/DotNetAnalyzers/IDisposableAnalyzers">IDisposableAnalyzers</a><br><a href="https://github.com/SergeyTeplyakov/ErrorProne.NET">ErrorProne.NET.CoreAnalyzers</a><br><a href="https://github.com/SergeyTeplyakov/ErrorProne.NET">ErrorProne.NET.Structs</a><br><br><br><br><br><br></td>
</tr>
</tbody>
</table>
<h4 id="what-to-do-if-the-check-update-tells-that-the-ssl-certificate-is-wrong-or-expired">What to do if the check update tells that the SSL certificate is wrong or expired?</h4>
<p>The software verifies the validity of the certificate of the update server in addition to the SHA-512 checksum of the installation file before downloading and running it.</p>
<p>You can manually check the latest version available online in case of problem.</p>
<h4 id="what-to-do-if-the-application-does-not-work-normally-despite-restoring-settings">What to do if the application does not work normally despite restoring settings?</h4>
<p>Use the Start Menu link:</p>
<p> <code>Ordisoftware\Hebrew Pi\Reset Hebrew Pi settings</code></p>
<p>This will erase all settings as well as those of old versions, which should resolve issues if there is a conflict, otherwise please contact support.</p>
<h4 id="what-is-the-windows-double-buffering">What is the Windows double-buffering?</h4>
<p>When enabled, this will speed up rendering of the main form when it is displayed, but it may cause a slight black flicker.</p>
<p>When disabled, top menu and some controls painting may cause latency, and dynamic items can be generated slowly the larger the number.</p>
<h2 id="application-frequently-asked-questions">Application Frequently asked questions</h2>
<h2 id="command-line-options">Command-line options</h2>
<ul>
<li><p>Change interface language (does not change the database content):</p>
<p><code>Ordisoftware.Hebrew.Words.exe --lang [en|fr]</code></p>
</li>
<li><p>Enable or disable future functionalities preview:</p>
<p><code>Ordisoftware.Hebrew.Calendar.exe --withpreview | --nopreview</code></p>
</li>
</ul>
<h2 id="keyboard-shortcuts">Keyboard shortcuts</h2>
<table>
<thead>
<tr>
<th>Keys</th>
<th>Actions</th>
</tr>
</thead>
<tbody>
<tr>
<td>Ctrl + Tab</td>
<td>Next view</td>
</tr>
<tr>
<td>Shift + Ctrl + Tab</td>
<td>Previous view</td>
</tr>
<tr>
<td>Alt + C</td>
<td>Calculator</td>
</tr>
<tr>
<td>Ctrl + H</td>
<td>Open Hebrew Letters</td>
</tr>
<tr>
<td>Ctrl + L</td>
<td>Open transcription guide</td>
</tr>
<tr>
<td>Ctrl + G</td>
<td>Open grammar guide</td>
</tr>
<tr>
<td>Ctrl + S</td>
<td>Save changes</td>
</tr>
<tr>
<td>Alt + D</td>
<td>Database menu</td>
</tr>
<tr>
<td>Alt + T</td>
<td>Tools menu</td>
</tr>
<tr>
<td>Alt + L</td>
<td>Web links menu</td>
</tr>
<tr>
<td>Alt + S</td>
<td>Settings menu</td>
</tr>
<tr>
<td>Alt + I</td>
<td>Information menu</td>
</tr>
<tr>
<td>F9</td>
<td>Preferences</td>
</tr>
<tr>
<td>F10</td>
<td>Log file window</td>
</tr>
<tr>
<td>F11</td>
<td>Usage statistics window</td>
</tr>
<tr>
<td>F12</td>
<td>About</td>
</tr>
<tr>
<td>Ctrl + F12</td>
<td>Take a window screenshot</td>
</tr>
<tr>
<td>Shift + F12</td>
<td>Take a view screenshot</td>
</tr>
<tr>
<td>Alt + F4 (or Escape)</td>
<td>Close window</td>
</tr>
</tbody>
</table>
<h2 id="changelog">Changelog</h2>
<h4 id="version-0.1">Version 0.1</h4>
<ul>
<li>Prototype #1 with data creation and reduction of repeating motifs.</li>
<li>Research and feasibility study code, partially organized and refactored.</li>
<li>No really defined user interface yet.</li>
</ul>
</body>
</html>