RubyGems - timequiz - Versions diffs - 0.2.1 → 0.2.2 - Mend

timequiz 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4ed1f632bbabb31d030be947ec4aae28b0c0f9d58b3235f6556241b498c278
-  data.tar.gz: 646ccff003ccbe5968ed8c4a166902fc8ea07450e600e4c74e881f1bc1523ecd
+  metadata.gz: daea9447b170a102d8da289d83d0a3308e7978ffd6398f685b3ba38c1a9b8a3e
+  data.tar.gz: 6d5c7ef90601c861f2c5af709cf6db654e76f7a21b6ef17c5e09889b9aa6e35c
 SHA512:
-  metadata.gz: 3f9a0b262a708759f9842e94efbaa736d92cf53d9c9950dbe454b18ea45b9eb4c3d9fe26ab3ee70874f25a59050dc73af1745b292d64b6f377e30e88807d60fb
-  data.tar.gz: 0e4e35c8f87c4c9a69f9cde7efebc31cf5582172eaaa6a3c75e08c596ca6a75e09b560f08a15d9e1788b78b4fe297574634a3f42c8c439195842f2cea747d63b
+  metadata.gz: eb8af1641167be90a179d1a659172ec38ebbaeae264c0aa0b32eeb878c1330cab038e8ffcc900c343105297e8265bf28006b8aee7349400a45651bc54fd83824
+  data.tar.gz: bfd0f786ec2df827c1ceb40968c13fe34c70ddab9c7fca3a1d5fb9fbc00ae3f95fba21ed441dd653ac93c7dda8e85592c3138f7611c3c1d00b4188338e92f618

data/doc/html/timequiz.html CHANGED Viewed

@@ -4,442 +4,132 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
-<title>Timequiz</title>
+<title>TIMEQUIZ</title>
 <style type="text/css">
 /*
-:Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
-:Copyright: This stylesheet has been placed in the public domain.
+:Author: Michael Uplawski
+:Contact: michael.uplawski@uplawski.eu
+:License: WTFPL 2.0, see http://www.wtfpl.net/about/
-Default cascading style sheet for the HTML output of Docutils.
-Despite the name, some widely supported CSS2 features are used.
-See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
-customize this style sheet.
+Stylesheet for use with Docutils.
 */
-/* used to remove borders from tables and images */
-.borderless, table.borderless td, table.borderless th {
-  border: 0 }
-table.borderless td, table.borderless th {
-  /* Override padding for "table.docutils td" with "! important".
-     The right padding separates the table cells. */
-  padding: 0 0.5em 0 0 ! important }
-.first {
-  /* Override more specific margin styles with "! important". */
-  margin-top: 0 ! important }
-.last, .with-subtitle {
-  margin-bottom: 0 ! important }
-.hidden {
-  display: none }
-.subscript {
-  vertical-align: sub;
-  font-size: smaller }
-.superscript {
-  vertical-align: super;
-  font-size: smaller }
-a.toc-backref {
-  text-decoration: none ;
-  color: black }
-blockquote.epigraph {
-  margin: 2em 5em ; }
-dl.docutils dd {
-  margin-bottom: 0.5em }
-object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
-  overflow: hidden;
-}
-/* Uncomment (and remove this text!) to get bold-faced definition list terms
-dl.docutils dt {
-  font-weight: bold }
-*/
-div.abstract {
-  margin: 2em 5em }
-div.abstract p.topic-title {
-  font-weight: bold ;
-  text-align: center }
-div.admonition, div.attention, div.caution, div.danger, div.error,
-div.hint, div.important, div.note, div.tip, div.warning {
-  margin: 2em ;
-  border: medium outset ;
-  padding: 1em }
-div.admonition p.admonition-title, div.hint p.admonition-title,
-div.important p.admonition-title, div.note p.admonition-title,
-div.tip p.admonition-title {
-  font-weight: bold ;
-  font-family: sans-serif }
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title, .code .error {
-  color: red ;
-  font-weight: bold ;
-  font-family: sans-serif }
-/* Uncomment (and remove this text!) to get reduced vertical space in
-   compound paragraphs.
-div.compound .compound-first, div.compound .compound-middle {
-  margin-bottom: 0.5em }
-div.compound .compound-last, div.compound .compound-middle {
-  margin-top: 0.5em }
-*/
-div.dedication {
-  margin: 2em 5em ;
-  text-align: center ;
-  font-style: italic }
-div.dedication p.topic-title {
-  font-weight: bold ;
-  font-style: normal }
-div.figure {
-  margin-left: 2em ;
-  margin-right: 2em }
-div.footer, div.header {
-  clear: both;
-  font-size: smaller }
-div.line-block {
-  display: block ;
-  margin-top: 1em ;
-  margin-bottom: 1em }
-div.line-block div.line-block {
-  margin-top: 0 ;
-  margin-bottom: 0 ;
-  margin-left: 1.5em }
-div.sidebar {
-  margin: 0 0 0.5em 1em ;
-  border: medium outset ;
-  padding: 1em ;
-  background-color: #ffffee ;
-  width: 40% ;
-  float: right ;
-  clear: right }
-div.sidebar p.rubric {
-  font-family: sans-serif ;
-  font-size: medium }
-div.system-messages {
-  margin: 5em }
-div.system-messages h1 {
-  color: red }
-div.system-message {
-  border: medium outset ;
-  padding: 1em }
-div.system-message p.system-message-title {
-  color: red ;
-  font-weight: bold }
-div.topic {
-  margin: 2em }
-h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
-h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
-  margin-top: 0.4em }
-h1.title {
-  text-align: center }
-h2.subtitle {
-  text-align: center }
-hr.docutils {
-  width: 75% }
-img.align-left, .figure.align-left, object.align-left, table.align-left {
-  clear: left ;
-  float: left ;
-  margin-right: 1em }
-img.align-right, .figure.align-right, object.align-right, table.align-right {
-  clear: right ;
-  float: right ;
-  margin-left: 1em }
+/* The defaults for docutils */
+@import url(html4css1.css);
-img.align-center, .figure.align-center, object.align-center {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
+body {
+  background-color:#200030;
+  font-family: Verdana,Helvetica,Univers;
+  color:#f0f0f0;
+  color:#f0f0f0;
 }
-table.align-center {
-  margin-left: auto;
-  margin-right: auto;
+h1 {color:cyan;font-size:1.5em;}
+h1.title {color:#a0a0f0;font-size:2em;}
+h2 {color:#ffffa0;}
+p, ul.simple, ol.simple, dt {margin-left:2em;}
+p.first {font-weight:bold;}
+dd {margin-left:4em;}
+td {color:#f0f080;}
+/* correct left margin of nested block tags*/
+dd p, li p {margin-left:0;}
+dd * ul {margin-left:0 ! important; }
+dd ul {margin-left:0 ! important; }
+dd dl dt, dd dl dd {margin-left:0 ! important;}
+dt {font-weight:bold;}
+dt, dd {color:#f0f0f0}
+tt.docutils {color:#000080;
+  background-color:#a080a0;
+  padding-left:3px;
+  padding-right:3px;
+  white-space:nowrap;
 }
-.align-left {
-  text-align: left }
+a.external {color:#ff90ff;}
-.align-center {
-  clear: both ;
-  text-align: center }
-.align-right {
-  text-align: right }
-/* reset inner alignment in figures */
-div.align-right {
-  text-align: inherit }
-/* div.align-center * { */
-/*   text-align: left } */
-.align-top    {
-  vertical-align: top }
-.align-middle {
-  vertical-align: middle }
-.align-bottom {
-  vertical-align: bottom }
-ol.simple, ul.simple {
-  margin-bottom: 1em }
-ol.arabic {
-  list-style: decimal }
-ol.loweralpha {
-  list-style: lower-alpha }
-ol.upperalpha {
-  list-style: upper-alpha }
-ol.lowerroman {
-  list-style: lower-roman }
-ol.upperroman {
-  list-style: upper-roman }
-p.attribution {
-  text-align: right ;
-  margin-left: 50% }
-p.caption {
-  font-style: italic }
-p.credits {
-  font-style: italic ;
-  font-size: smaller }
-p.label {
-  white-space: nowrap }
-p.rubric {
-  font-weight: bold ;
-  font-size: larger ;
-  color: maroon ;
-  text-align: center }
-p.sidebar-title {
-  font-family: sans-serif ;
-  font-weight: bold ;
-  font-size: larger }
-p.sidebar-subtitle {
-  font-family: sans-serif ;
-  font-weight: bold }
-p.topic-title {
-  font-weight: bold }
-pre.address {
-  margin-bottom: 0 ;
-  margin-top: 0 ;
-  font: inherit }
-pre.literal-block, pre.doctest-block, pre.math, pre.code {
-  margin-left: 2em ;
-  margin-right: 2em }
-pre.code .ln { color: gray; } /* line numbers */
-pre.code, code { background-color: #eeeeee }
-pre.code .comment, code .comment { color: #5C6576 }
-pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
-pre.code .literal.string, code .literal.string { color: #0C5404 }
-pre.code .name.builtin, code .name.builtin { color: #352B84 }
-pre.code .deleted, code .deleted { background-color: #DEB0A1}
-pre.code .inserted, code .inserted { background-color: #A3D289}
-span.classifier {
-  font-family: sans-serif ;
-  font-style: oblique }
-span.classifier-delimiter {
-  font-family: sans-serif ;
-  font-weight: bold }
-span.interpreted {
-  font-family: sans-serif }
-span.option {
-  white-space: nowrap }
-span.pre {
-  white-space: pre }
-span.problematic, pre.problematic {
-  color: red }
-span.section-subtitle {
-  /* font-size relative to parent (h1..h6 element) */
-  font-size: 80% }
-table.citation {
-  border-left: solid 1px gray;
-  margin-left: 1px }
-table.docinfo {
-  margin: 2em 4em }
-table.docutils {
-  margin-top: 0.5em ;
-  margin-bottom: 0.5em }
-table.footnote {
-  border-left: solid 1px black;
-  margin-left: 1px }
-table.docutils td, table.docutils th,
-table.docinfo td, table.docinfo th {
-  padding-left: 0.5em ;
-  padding-right: 0.5em ;
-  vertical-align: top }
-table.docutils th.field-name, table.docinfo th.docinfo-name {
-  font-weight: bold ;
-  text-align: left ;
-  white-space: nowrap ;
-  padding-left: 0 }
-/* "booktabs" style (no vertical lines) */
-table.docutils.booktabs {
-  border: 0px;
-  border-top: 2px solid;
-  border-bottom: 2px solid;
-  border-collapse: collapse;
-}
-table.docutils.booktabs * {
-  border: 0px;
+blockquote {background-color:#ffc090;
+  padding:0.5em;
+  border-radius:0.5em;
 }
-table.docutils.booktabs th {
-  border-bottom: thin solid;
-  text-align: left;
-}
-h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
-h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
-  font-size: 100% }
-ul.auto-toc {
-  list-style-type: none }
 </style>
 </head>
 <body>
 <div class="document" id="timequiz">
 <h1 class="title">TIMEQUIZ</h1>
-<h2 class="subtitle" id="play-a-history-quiz-game">play a history quiz game</h2>
+<h2 class="subtitle" id="play-a-history-quiz-game">Play a history-quiz game</h2>
 <div class="section" id="synopsis">
 <h1>SYNOPSIS</h1>
 <p>timequiz [options]</p>
-<p>Called without any option, the game is started with the events that are included
-in the installed program package. There are not many.</p>
+<p>Run timequiz without any options to begin a quiz using the default set of
+historical events—the provided collection is modest in size.</p>
 </div>
 <div class="section" id="description">
 <h1>DESCRIPTION</h1>
-<p>The general idea is to put historical events in the right order. In the
-beginning, a limited number of events (3 at the time of this writing) is
-presented and you have to indicate the right order of these events. All the
-following rounds will confront you with just 1 additional event and you must
-find for the new event the right spot in the previously ordered list, i.e.
-after one of the listed events or earlier than any of the known events. After
-each round, the first one inclusive, your performance is evaluated. You can
-then choose to continue with a new event or, if you like, read a short
-description of any of the events, already in the list.</p>
-<p>The game continues in this way until you push the 'q' button to quit or until
-a maximal number of events (currently 15) have been handled.</p>
-<div class="section" id="you-do-not-need-to-know-it-all">
-<h2>You do not need to know it all</h2>
-<p>Beware that to win a round, it is oftentimes not necessary to really know the
-date of an event. Pure logic and reasonable guesses may be sufficient to find
-the right spot within a historical context or to exclude events as too far in
-the past or future of the currently handled event. Reading the descriptive
-comments to an event may later help you get different events into context.</p>
+<p>The game presents a limited number of historical events (currently three) in
+random order. Your task is to correctly arrange them chronologically. In each
+subsequent round, a single new event appears—you must place it in the correct
+position relative to the previously ordered events (either before one of the
+listed events or later).</p>
+<p>After every round—including the first—your performance is assessed. You may
+then choose to proceed with another event or review the brief description of
+any event already in the sequence.</p>
+<p>The game continues until you press q to quit or until the maximum of 15 events
+have been played.</p>
+<div class="section" id="you-dont-need-to-know-every-date">
+<h2>YOU DON’T NEED TO KNOW EVERY DATE</h2>
+<p>Winning often does not require exact historical knowledge. Instead, logical
+reasoning or educated guesses—eliminating events that are clearly too early or
+too late—usually suffices. Reading the event descriptions may also help you
+situate other events in historical context later on.</p>
 </div>
 </div>
-<div class="section" id="options-not-needed-to-play-the-game">
-<h1>OPTIONS (not needed to play the game)</h1>
+<div class="section" id="options-not-needed-to-play">
+<h1>OPTIONS (not needed to play)</h1>
 <p><strong>-a, --add</strong>                       Add a new event to the game</p>
-<p><strong>-e, --event</strong> [EVENT]             Name of the new event</p>
-<p><strong>-y, --year</strong> [YEAR]               Year of the new event</p>
-<p><strong>-b, --background</strong> [INFO]         Background information for the new event</p>
-<p><strong>-f, --file</strong> [FILE]               The file, where events are read from or written to</p>
-<p><strong>-d, --debug</strong>                     Be verbose</p>
-<p><strong>-v, --version</strong>                   Show program version</p>
-<p><strong>-h, --help</strong>                      Show a help text</p>
+<p><strong>-e, --event</strong> [EVENT]             Provide a name of the new event</p>
+<p><strong>-y, --year</strong> [YEAR]               Specify the year of the new event</p>
+<p><strong>-b, --background</strong> [INFO]         Supply background information for the new event</p>
+<p><strong>-f, --file</strong> [FILE]               Specify the file for reading/writing events</p>
+<p><strong>-d, --debug</strong>                     Enable verbose debug output</p>
+<p><strong>-v, --version</strong>                   Display program version</p>
+<p><strong>-h, --help</strong>                      Show help message</p>
 <div class="section" id="the-options-in-detail">
 <h2>The Options in detail:</h2>
 <dl class="docutils">
 <dt>-a --add</dt>
-<dd>This option imposes that -e, -y, and -f be given, too. In consequence, it
-will be considered superfluous and removed in future versions of the program.</dd>
-<dt>-e --event</dt>
-<dd>Name the event to add to the events-file. For this option to take effect, -a,
--y and -f are needed, too. Beware to enclose the value with quotes, like in, e.g.
---event &quot;Some guy was born and something broke&quot;</dd>
-<dt>-y --year</dt>
-<dd>Is followed by a year, like -y 1244</dd>
-<dt>-b --background</dt>
-<dd>Should be used to provide background-information to an event. While this
-option is ... optional, the information will help solving quizzes and may be
-educative to the player... do not abuse, though.
-Example: -b &quot;The phenomenon was bearing no significance whatsoever&quot;</dd>
-<dt>-f --file</dt>
-<dd>Name the “events-file” which will be used for either creating the quizzes
-randomly or adding events to an existing list of events. The file must be
-readable to serve for a quiz and writable to accept new events. If it does
-not exist, it is created and some exemplary events are included on top.
-Example: --file ~/my_history_quiz</dd>
+<dd>Requires -e, -y, and -f. This redundancy may be removed in future versions.</dd>
+<dt>-e --event [EVENT]</dt>
+<dd>The name of the event to add. Requires --add, --year, and --file. Use quotes
+for multi-word events, e.g., --event &quot;Some Guy Was Born and Something Broke&quot;.</dd>
+<dt>-y --year [YEAR]</dt>
+<dd>The year of the event, e.g., -y 1244.</dd>
+<dt>-b --background [INFO]</dt>
+<dd>Optional context to help with the quiz—use sparingly. For example: -b &quot;The
+phenomenon was of no significance whatsoever&quot;.</dd>
+<dt>-f --file [FILE]</dt>
+<dd>Path to the events file used for quizzes or for adding new events. If the file
+does not exist, it is created with some sample events. It must be readable for
+quizzes and writable for additions.</dd>
 <dt>-d --debug</dt>
-<dd>Be verbose. This switches on the output of debug-messages that have been left
-in the program code. Probably useless.</dd>
+<dd>Enables verbose debugging output. Mainly useful for developers.</dd>
 <dt>-v --version</dt>
-<dd>Shows the program version</dd>
+<dd>Display the current version of the program.</dd>
 <dt>-h --help</dt>
-<dd>Shows the option-summary.</dd>
+<dd>Show this list of options and usage instructions.</dd>
 </dl>
 </div>
 </div>
 <div class="section" id="game-example">
 <h1>GAME EXAMPLE</h1>
-<p>Calling timequiz without arguments on the command-line, you are confronted with
-three arbitrary, historical events, like in the following screen:</p>
+<p>Launching timequiz with no options displays three random historical events,
+prompting:</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="100%" />
@@ -456,12 +146,10 @@ three arbitrary, historical events, like in the following screen:</p>
 </tr>
 </tbody>
 </table>
-<p>You type in the three numbers in the order that you consider chronologically
-correct, like &quot;321&quot; (you do not have to push return after each number). The
-game will respond by showing you the correct order of events with the
-corresponding years and an evaluation of your input. You are also prompted to
-decide if you want to play with a new arbitrary event or first be shown some
-information about the listed events:</p>
+<p>Enter your sequence (e.g., 321) without needing to press Enter after each
+number. The game then shows the correct order with years and evaluates your
+input. You’ll be asked if you wish to continue with a new event or view more
+info on the listed events.</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="100%" />
@@ -471,7 +159,11 @@ information about the listed events:</p>
 </tr>
 </tbody>
 </table>
-<p>If you push 'a', a new event is shown:</p>
+<p>To continue:</p>
+<p>Press a number to view an event’s details,</p>
+<p>a to add a new random event, or</p>
+<p>q to quit.</p>
+<p>If you choose a, here’s how the next prompt may appear:</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="100%" />
@@ -483,33 +175,25 @@ information about the listed events:</p>
 </tr>
 </tbody>
 </table>
-<p>You can now decide, which of the three previous events precedes the death of
-the Italian painter and either put in the (current) number of that previous
-event or the number 0 (zero) if you consider that Lorenzo Lotto died well
-before any of the other events (which would, of course, be false in the
-example).  You have to push the return-button after your input, as it can
-contain an arbitrary number of ciphers, later in the game.</p>
+<p>You must then enter the corresponding number or 0 if you believe that the event
+occurred before all listed events (which, in this case, would be historically
+inaccurate). Press Enter to submit your answer.</p>
 </div>
-<div class="section" id="other-information">
-<h1>Other Information</h1>
+<div class="section" id="additional-information">
+<h1>ADDITIONAL INFORMATION</h1>
 <dl class="docutils">
-<dt>Development and source code</dt>
-<dd>timequiz has been written in Ruby. As Ruby is an interpreted programming
-language, the executable file and all those that it may refer to at one point
-in time, are themselves the source-files of the current program-version. You
-can open them in any text-editor to scrutinize the source-code. If you have
-received the program as a Ruby-gem, you can also decompress a copy of the
-gem-file with <em>tar -x</em>, then <em>tar -xzf</em>.</dd>
-<dt>Bugs</dt>
-<dd>At one time during the game, the list of already known events is incorrectly
-wrapped and continues to be.</dd>
+<dt>Development &amp; Source Code</dt>
+<dd>timequiz is written in Ruby. As it's interpreted, the executable is
+essentially the source code—you can open it in any text editor. If installed
+from a Ruby gem, you can extract it using <tt class="docutils literal">tar <span class="pre">-x</span></tt>, then <tt class="docutils literal">tar <span class="pre">-xzf</span></tt>.</dd>
+<dt>Known Bug</dt>
+<dd>At times, the list of events may wrap incorrectly in the display.</dd>
 <dt>License</dt>
-<dd>timequiz is distributed under the conditions of the GNU General Public
-License, version 3.</dd>
+<dd>Distributed under the GNU General Public License (GPL) version 3.</dd>
 <dt>Author</dt>
-<dd>timequiz has been developed by Michael Uplawski
-&lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</dd>
+<dd>Developed by Michael Uplawski &lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</dd>
 </dl>
+<p>Ω</p>
 </div>
 </div>
 </body>

data/doc/man/timequiz.6.gz CHANGED Viewed

Binary file

data/doc/pdf/timequiz.pdf CHANGED Viewed

Binary file

data/doc/rst/timequiz.rst CHANGED Viewed

@@ -2,100 +2,94 @@
  TIMEQUIZ
 =======================
 ----------------------------------------
- play a history quiz game
+Play a history-quiz game
 ----------------------------------------
 SYNOPSIS
 =======================
 timequiz [options]
-Called without any option, the game is started with the events that are included
-in the installed program package. There are not many.
+Run timequiz without any options to begin a quiz using the default set of
+historical events—the provided collection is modest in size.
 DESCRIPTION
 =======================
-The general idea is to put historical events in the right order. In the
-beginning, a limited number of events (3 at the time of this writing) is
-presented and you have to indicate the right order of these events. All the
-following rounds will confront you with just 1 additional event and you must
-find for the new event the right spot in the previously ordered list, i.e.
-after one of the listed events or earlier than any of the known events. After
-each round, the first one inclusive, your performance is evaluated. You can
-then choose to continue with a new event or, if you like, read a short
-description of any of the events, already in the list.
-The game continues in this way until you push the 'q' button to quit or until
-a maximal number of events (currently 15) have been handled.
-You do not need to know it all
---------------------------------
-Beware that to win a round, it is oftentimes not necessary to really know the
-date of an event. Pure logic and reasonable guesses may be sufficient to find
-the right spot within a historical context or to exclude events as too far in
-the past or future of the currently handled event. Reading the descriptive
-comments to an event may later help you get different events into context.
-OPTIONS (not needed to play the game)
+The game presents a limited number of historical events (currently three) in
+random order. Your task is to correctly arrange them chronologically. In each
+subsequent round, a single new event appears—you must place it in the correct
+position relative to the previously ordered events (either before one of the
+listed events or later).
+After every round—including the first—your performance is assessed. You may
+then choose to proceed with another event or review the brief description of
+any event already in the sequence.
+The game continues until you press q to quit or until the maximum of 15 events
+have been played.
+YOU DON’T NEED TO KNOW EVERY DATE
+---------------------------------
+Winning often does not require exact historical knowledge. Instead, logical
+reasoning or educated guesses—eliminating events that are clearly too early or
+too late—usually suffices. Reading the event descriptions may also help you
+situate other events in historical context later on.
+OPTIONS (not needed to play)
 =====================================
 **-a, --add**                       Add a new event to the game
-**-e, --event** [EVENT]             Name of the new event
+**-e, --event** [EVENT]             Provide a name of the new event
-**-y, --year** [YEAR]               Year of the new event
+**-y, --year** [YEAR]               Specify the year of the new event
-**-b, --background** [INFO]         Background information for the new event
+**-b, --background** [INFO]         Supply background information for the new event
-**-f, --file** [FILE]               The file, where events are read from or written to
+**-f, --file** [FILE]               Specify the file for reading/writing events
-**-d, --debug**                     Be verbose
+**-d, --debug**                     Enable verbose debug output
-**-v, --version**                   Show program version
+**-v, --version**                   Display program version
-**-h, --help**                      Show a help text
+**-h, --help**                      Show help message
 The Options in detail:
 ----------------------
 -a --add
-  This option imposes that -e, -y, and -f be given, too. In consequence, it
-  will be considered superfluous and removed in future versions of the program.
--e --event
-  Name the event to add to the events-file. For this option to take effect, -a,
-  -y and -f are needed, too. Beware to enclose the value with quotes, like in, e.g.
-  --event "Some guy was born and something broke"
--y --year
-  Is followed by a year, like -y 1244
--b --background
-  Should be used to provide background-information to an event. While this
-  option is ... optional, the information will help solving quizzes and may be
-  educative to the player... do not abuse, though.
-  Example: -b "The phenomenon was bearing no significance whatsoever"
--f --file
-  Name the “events-file” which will be used for either creating the quizzes
-  randomly or adding events to an existing list of events. The file must be
-  readable to serve for a quiz and writable to accept new events. If it does
-  not exist, it is created and some exemplary events are included on top.
-  Example: --file ~/my_history_quiz
+  Requires -e, -y, and -f. This redundancy may be removed in future versions.
+-e --event [EVENT]
+  The name of the event to add. Requires --add, --year, and --file. Use quotes
+  for multi-word events, e.g., --event "Some Guy Was Born and Something Broke".
+-y --year [YEAR]
+  The year of the event, e.g., -y 1244.
+-b --background [INFO]
+  Optional context to help with the quiz—use sparingly. For example: -b "The
+  phenomenon was of no significance whatsoever".
+-f --file [FILE]
+ Path to the events file used for quizzes or for adding new events. If the file
+ does not exist, it is created with some sample events. It must be readable for
+ quizzes and writable for additions.
 -d --debug
-  Be verbose. This switches on the output of debug-messages that have been left
-  in the program code. Probably useless.
+  Enables verbose debugging output. Mainly useful for developers.
 -v --version
-  Shows the program version
+  Display the current version of the program.
 -h --help
-  Shows the option-summary.
+  Show this list of options and usage instructions.
 GAME EXAMPLE
 =======================
-Calling timequiz without arguments on the command-line, you are confronted with
-three arbitrary, historical events, like in the following screen:
+Launching timequiz with no options displays three random historical events,
+prompting:
 +---------------------------------------------------------------------------+
 |Put the following events into the right chronological order (e.g.: 2 3 1). |
@@ -107,18 +101,24 @@ three arbitrary, historical events, like in the following screen:
 |Available: 1, 2, 3)                                                        |
 +---------------------------------------------------------------------------+
-You type in the three numbers in the order that you consider chronologically
-correct, like "321" (you do not have to push return after each number). The
-game will respond by showing you the correct order of events with the
-corresponding years and an evaluation of your input. You are also prompted to
-decide if you want to play with a new arbitrary event or first be shown some
-information about the listed events:
+Enter your sequence (e.g., 321) without needing to press Enter after each
+number. The game then shows the correct order with years and evaluates your
+input. You’ll be asked if you wish to continue with a new event or view more
+info on the listed events.
 +------------------------------------------------------------------------------------------------------+
 |Enter number for more information about an event, 'a' to play with one new, random event, 'q' to quit.|
 +------------------------------------------------------------------------------------------------------+
-If you push 'a', a new event is shown:
+To continue:
+Press a number to view an event’s details,
+a to add a new random event, or
+q to quit.
+If you choose a, here’s how the next prompt may appear:
 +----------------------------------------------------------------------------------------------------------+
 |Indicate the event from the previous list, which precedes the following, or '0' (zero) to put it in front:|
@@ -126,32 +126,24 @@ If you push 'a', a new event is shown:
 |The Italian painter Lorenzo Lotto dies.                                                                   |
 +----------------------------------------------------------------------------------------------------------+
-You can now decide, which of the three previous events precedes the death of
-the Italian painter and either put in the (current) number of that previous
-event or the number 0 (zero) if you consider that Lorenzo Lotto died well
-before any of the other events (which would, of course, be false in the
-example).  You have to push the return-button after your input, as it can
-contain an arbitrary number of ciphers, later in the game.
-Other Information
-====================
-Development and source code
-  timequiz has been written in Ruby. As Ruby is an interpreted programming
-  language, the executable file and all those that it may refer to at one point
-  in time, are themselves the source-files of the current program-version. You
-  can open them in any text-editor to scrutinize the source-code. If you have
-  received the program as a Ruby-gem, you can also decompress a copy of the
-  gem-file with *tar -x*, then *tar -xzf*.
-Bugs
-  At one time during the game, the list of already known events is incorrectly
-  wrapped and continues to be.
+You must then enter the corresponding number or 0 if you believe that the event
+occurred before all listed events (which, in this case, would be historically
+inaccurate). Press Enter to submit your answer.
+ADDITIONAL INFORMATION
+======================
+Development & Source Code
+  timequiz is written in Ruby. As it's interpreted, the executable is
+  essentially the source code—you can open it in any text editor. If installed
+  from a Ruby gem, you can extract it using ``tar -x``, then ``tar -xzf``.
+Known Bug
+  At times, the list of events may wrap incorrectly in the display.
 License
-  timequiz is distributed under the conditions of the GNU General Public
-  License, version 3.
+  Distributed under the GNU General Public License (GPL) version 3.
 Author
-  timequiz has been developed by Michael Uplawski
-  <michael.uplawski@uplawski.eu>
+  Developed by Michael Uplawski <michael.uplawski@uplawski.eu>
+Ω

data/lib/version.rb CHANGED Viewed

@@ -15,7 +15,7 @@
  ***************************************************************************/
 =end
-VERSION = '0.2.1'
+VERSION = '0.2.2'
 SUMMARY = 'New documentation- and homepage URIs.'
 AUTHOR = 'Michael Uplawski'
 AUTHOR_MAIL = '<michael.uplawski@uplawski.eu>'

data/timequiz.gemspec CHANGED Viewed

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.license     = 'Nonstandard'
   s.required_ruby_version = '>= 2.7'
   s.metadata = {
-    "homepage_uri" => 'https://www.uplawski.eu/software/timequiz/timequiz.html',
+    "homepage_uri" => 'https://www.uplawski.eu/software/timequiz/',
     "documentation_uri" => 'https://www.uplawski.eu/software/timequiz/man_timequiz.html'
   }
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: timequiz
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-08-27 00:00:00.000000000 Z
 dependencies: []
 description: Play a history game
 email: michael.uplawski@uplawski.eu
@@ -41,7 +41,7 @@ files:
 licenses:
 - Nonstandard
 metadata:
-  homepage_uri: https://www.uplawski.eu/software/timequiz/timequiz.html
+  homepage_uri: https://www.uplawski.eu/software/timequiz/
   documentation_uri: https://www.uplawski.eu/software/timequiz/man_timequiz.html
 rdoc_options: []
 require_paths: