Skip to content

Commit

Permalink
update and style readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DGrothe-PhD committed Jul 23, 2024
1 parent d7403c0 commit f656bce
Show file tree
Hide file tree
Showing 5 changed files with 265 additions and 9 deletions.
82 changes: 82 additions & 0 deletions doc/Readme_DEU.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="author" content="MarkdownViewer++" />
<title>Readme_DEU.md</title>
<style type="text/css">

/* Avoid page breaks inside the most common attributes, especially for exports (i.e. PDF) */
td, h1, h2, h3, h4, h5, p, ul, ol, li {
page-break-inside: avoid;
}

</style>
</head>
<body>
<link rel="stylesheet" href="docstyles.css">
<h1 id="systemanforderungen">Systemanforderungen</h1>
<ul>
<li>Windows 11</li>
<li>Windows 10 1607+</li>
<li>Windows 8.1</li>
<li>Windows 7 SP1</li>
<li>Läuft auf 32-bit- (x86) und 64-bit-Architekturen</li>
<li>.NET 6 Laufzeitumgebung benötigt. <br />
Falls diese noch nicht installiert ist, wird (z. B. unter Windows 8.1) eine Fenstermeldung mit einem Download-Link erscheinen.</li>
</ul>
<h1 id="installation">Installation</h1>
<p>Portable Anwendung, benötigt keine Installation, einfach das zip entpacken und Doppelklick auf die .exe-Datei.</p>
<h1 id="spielanleitung">Spielanleitung</h1>
<p>Anregung hierzu gab ein im vorigen Jahrhundert verkauftes Brettspiel, das wir in der Familie gern gespielt haben.<br />
Der Computer legt ein Wort fest, das der Nutzer dann raten darf.<br />
Dazu klickt der Nutzer auf ein Buchstabenfeld und wählt den gewünschten Buchstaben aus.</p>
<p>Erlaubt sind nur Großbuchstaben von A-Z, keine Umlaute.</p>
<p>Die Wortlänge kann - angelehnt an das Brettspiel - bei vier belassen oder auf drei oder fünf gesetzt werden.</p>
<p>Zum Beenden eines Spiels oder zum Neubeginn mit der rechten Maus
irgendwo ins geöffnete Spielfenster klicken und den passenden Menüpunkt auswählen.</p>
<p>Bei Eingabe der Buchstaben über den Tastatur-Button werden nacheinander von links nach rechts alle freien Felder gefüllt.</p>
<p>Bereits gefüllte Felder werden hierbei übersprungen.</p>
<p>Man kann sich also vorab z. B. auf das dritte Feld einen Buchstaben legen und über die anderen Felder noch nachdenken.</p>
<p>Durch einen Klick auf ein einzelnes Feld kann ein einzelner Buchstabe gelegt oder überschrieben werden.</p>
<h2 id="auswertung">Auswertung</h2>
<p>Durch einen Klick auf den OK-Button startet die Auswertung der Eingabe, falls alle Buchstaben gesetzt sind.</p>
<p>Es erscheinen kein bis (drei, vier, oder fünf - je nach Wortlänge) Pins, die durch ihre Farbe anzeigen, ob es einen Treffer gab.</p>
<h2 id="beispiel">Beispiel:</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">Vorgang</th>
<th>Wort</th>
<th>Pins</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">Computer legt hin:</td>
<td>NASS</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">Teilnehmer legt:</td>
<td>WEIN</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">Teilnehmer legt:</td>
<td>NEIN</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">Teilnehmer legt:</td>
<td>NAPF</td>
<td>⚫⚫</td>
</tr>
</tbody>
</table>
<p>etc.</p>

</body>
</html>

35 changes: 26 additions & 9 deletions doc/Readme_DEU.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
<link rel="stylesheet" href="docstyles.css">

# Systemanforderungen
* Windows 11
* Windows 10 1607+
* Windows 8.1
* Windows 7 SP1
* Läuft auf 32-bit- (x86) und 64-bit-Architekturen
* .NET 6 Laufzeitumgebung benötigt. \
Falls diese noch nicht installiert ist, wird (z. B. unter Windows 8.1) eine Fenstermeldung mit einem Download-Link erscheinen.

# Installation
Portable Anwendung, benötigt keine Installation, einfach das zip entpacken und Doppelklick auf die .exe-Datei.

# Spielanleitung

Anregung hierzu gab ein im vorigen Jahrhundert verkauftes Brettspiel, das wir in der Familie gern gespielt haben.\
Expand All @@ -11,7 +25,11 @@ Die Wortlänge kann - angelehnt an das Brettspiel - bei vier belassen oder auf d
Zum Beenden eines Spiels oder zum Neubeginn mit der rechten Maus
irgendwo ins geöffnete Spielfenster klicken und den passenden Menüpunkt auswählen.

Bei Eingabe der Buchstaben über den Tastatur-Button werden nacheinander von links nach rechts alle freien Felder gefüllt. Bereits gefüllte Felder werden hierbei übersprungen. Man kann sich also vorab z.&nbsp;B. auf das dritte Feld einen Buchstaben legen und über die anderen Felder noch nachdenken.
Bei Eingabe der Buchstaben über den Tastatur-Button werden nacheinander von links nach rechts alle freien Felder gefüllt.

Bereits gefüllte Felder werden hierbei übersprungen.

Man kann sich also vorab z.&nbsp;B. auf das dritte Feld einen Buchstaben legen und über die anderen Felder noch nachdenken.

Durch einen Klick auf ein einzelnes Feld kann ein einzelner Buchstabe gelegt oder überschrieben werden.

Expand All @@ -21,12 +39,11 @@ Durch einen Klick auf den OK-Button startet die Auswertung der Eingabe, falls al
Es erscheinen kein bis (drei, vier, oder fünf - je nach Wortlänge) Pins, die durch ihre Farbe anzeigen, ob es einen Treffer gab.

## Beispiel:
<div style="background-color:#a5efca">
<table><tr>
<tr><td>Computer legt hin:<td/>NASS</td></tr>
<tr><td>Teilnehmer legt:<td/>WEIN<td/>⚪</td></tr>
<tr><td>Teilnehmer legt:<td/>NEIN<td/>⚫</td></tr>
<tr><td>Teilnehmer legt:<td/>NAPF<td/>⚫⚫</td></tr>
</table>
| Vorgang | Wort | Pins |
|:-------------------|------|------|
| Computer legt hin: | NASS | |
| Teilnehmer legt: | WEIN ||
| Teilnehmer legt: | NEIN ||
| Teilnehmer legt: | NAPF | ⚫⚫ |

etc.
</div>
82 changes: 82 additions & 0 deletions doc/Readme_ENG.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="author" content="MarkdownViewer++" />
<title>Readme_ENG.md</title>
<style type="text/css">

/* Avoid page breaks inside the most common attributes, especially for exports (i.e. PDF) */
td, h1, h2, h3, h4, h5, p, ul, ol, li {
page-break-inside: avoid;
}

</style>
</head>
<body>
<link rel="stylesheet" href="docstyles.css">
<h1 id="system-requirements">System requirements</h1>
<ul>
<li>Windows 11</li>
<li>Windows 10 1607+</li>
<li>Windows 8.1</li>
<li>Windows 7 SP1</li>
<li>Works on both x86 and x64 architecture</li>
<li>.NET 6 runtime required, can be easily installed from the link in the message box</li>
</ul>
<h1 id="installation">Installation</h1>
<p>Mastermind is portable, no installation is required. To start the game, unpack the zip and double-click the .exe file.</p>
<h2 id="game-instructions">Game instructions</h2>
<p>The inspiration for this came from a board game sold in the last century that we enjoyed playing in the family.<br />
The computer determines a word, which the user is then allowed to guess.<br />
To do this, the user clicks on a letter field and selects the desired letter.</p>
<p>Only capital letters from A-Z are allowed, no umlauts.<br />
The word length can be left at four (as in the board game) or set to three or five.</p>
<p>To end a game or to start a new game, click anywhere in the open game window with the right mouse button. <br />
Then select the appropriate menu item from the context menu strip.</p>
<p>When entering the letters via the keyboard button, all free fields are filled one by one from left to right.
If you already filled one or two of the fields, these will be skipped. <br />
So you can put a letter in advance e.g. on the third field and still think about the other fields.</p>
<p>By clicking on a single field, a single letter can be placed or overwritten.
Typing of letters and backspace also works as expected.</p>
<h3 id="evaluation">Evaluation</h3>
<p>Clicking the OK button starts the evaluation of the input, if all letters are set.</p>
<p>Now zero to (three, four, or five - depending on the word length) pins appear, which indicate a matching letter by their color.</p>
<h3 id="example">Example:</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">Vorgang</th>
<th>Wort</th>
<th>Pins</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">Computer chooses:</td>
<td>THIS</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">User tries:</td>
<td>WINE</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">User:</td>
<td>PENS</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">User:</td>
<td>THEM</td>
<td>⚫⚫</td>
</tr>
</tbody>
</table>
<p>etc.</p>

</body>
</html>

47 changes: 47 additions & 0 deletions doc/Readme_ENG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<link rel="stylesheet" href="docstyles.css">

# System requirements
* Windows 11
* Windows 10 1607+
* Windows 8.1
* Windows 7 SP1
* Works on both x86 and x64 architecture
* .NET 6 runtime required, can be easily installed from the link in the message box

# Installation
Mastermind is portable, no installation is required. To start the game, unpack the zip and double-click the .exe file.

## Game instructions

The inspiration for this came from a board game sold in the last century that we enjoyed playing in the family.\
The computer determines a word, which the user is then allowed to guess.\
To do this, the user clicks on a letter field and selects the desired letter.

Only capital letters from A-Z are allowed, no umlauts.\
The word length can be left at four (as in the board game) or set to three or five.

To end a game or to start a new game, click anywhere in the open game window with the right mouse button. \
Then select the appropriate menu item from the context menu strip.

When entering the letters via the keyboard button, all free fields are filled one by one from left to right.
If you already filled one or two of the fields, these will be skipped. \
So you can put a letter in advance e.g. on the third field and still think about the other fields.

By clicking on a single field, a single letter can be placed or overwritten.
Typing of letters and backspace also works as expected.

### Evaluation
Clicking the OK button starts the evaluation of the input, if all letters are set.

Now zero to (three, four, or five - depending on the word length) pins appear, which indicate a matching letter by their color.

### Example:

| Vorgang | Wort | Pins |
|:-------------------|------|------|
| Computer chooses: | THIS | |
| User tries: | WINE ||
| User: | PENS ||
| User: | THEM | ⚫⚫ |

etc.
28 changes: 28 additions & 0 deletions doc/docstyles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
body{
font-family:Calibri;
}


th,td{
text-align:right;
padding:0.5em;
}

th:nth-child(4),td:nth-child(4){
text-align:left;
padding-right:3em;
}
thead{
background-color: darkseagreen;
}

table, th, td{
border: 1px solid gray;
border-collapse: collapse;
}
tr:nth-child(even){
background-color: lavender;
}
tr:hover{
background-color: darkseagreen;
}

0 comments on commit f656bce

Please sign in to comment.