docs: update README

Author: bartekjaszczak

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "practicestuff"
-version = "0.2.6"
+version = "0.3.0"
 description = "Simple CLI trainer for improving calculation and memorisation skills"
 authors = ["Bartłomiej Jaszczak"]
 repository = "https://gitlab.com/bartekjaszczak/practicestuff"

Cargo.toml

@@ -1,18 +1,49 @@
 # WIP
 
-This is a work in progress and not all functionalities may function correctly (or even be implemented).
+This is a work in progress. Basic functionality has already been implemented, but there are a few things I'm planning to do:
+
+- coloured output with --colour option to control it
+- time rush mode (as many correct answers in given time)
+- various feedback options (to replace boring "Correct" and "Incorrect" messages)
+- GitLab & GitHub CI integration
 
 # practicestuff
 
 **practicestuff** is a CLI app designed to help you practise skills by asking questions and checking your answers. At the end, you'll see a number of correct answers, as well as some statistics. You can stop early by pressing `Ctrl+C`.
 
 The application should work on all platforms.
 
-List of skills:
+Current list of skills:
 
 - powers of a number
 - multiplication table (times table)
-- doomsday algorithm (not yet implemented)
+- doomsday algorithm
+
+## Installation
+
+To install the application, you need cargo. Then, run:
+
+```bash
+cargo install practicestuff
+```
+
+## Usage
+
+If you're fine with the defaults, choose a skill to practise (e.g., powers) and simply run:
+
+```bash
+practicestuff powers
+```
+
+You'll be presented with 20 questions and at the end you'll see how it went. If you don't like the defaults, you can adjust some settings. To display configuration options use help:
+
+```bash
+# General configuration options and available commands/skills
+practicestuff --help
+
+# Powers specific options
+practicestuff powers --help
+```
 
 ## Configuration options
 
@@ -35,40 +66,16 @@ Allows to practise powers. Configurable parameters include:
 
 Allows to practise multiplications. Factors' range is configurable (default: 1-10 (regular times table)).
 
-# Development
-
-## Initial assumptions
-
-- User has to choose a mode (skill) and optionally some flags/settings
-- User is presented with a number of questions for certain skill and has to type a correct answer
-- User should be able to quit at any time
-- Some statistics should be presented (accuracy, response time, overall time)
-- There should be a help flag available
-- Argument parsing should be done without `clap` or any other library
-- There should be some options to be set:
-    - Option to set number of questions (including endless mode)
-    - Option to show current accuracy between questions (default: true). Overall accuracy is presented at the end nevertheless
-    - Option to exit early
-    - Option to change behaviour on incorrect answer: continue to next question, show correct answer and continue, repeat
-- It should be relatively easy to add new skills
-- All skills should be configurable
-
-## Current TODO
+### Doomsday algorithm
 
-### Doomsday
+Allows to practise calculating the day of the week for a given date. Year range is configurable. By default, the application presents questions with dates ranging from ~1900 to ~2100, with a slight chance to go beyond. When either lower or upper limit is set, the date is picked randomly with equal probability for each year.
 
-- help & usage prompts
-- question generation w/ options
-- tests
+# Rationale
 
-### Improvements
+I created this simple app because I wanted to learn and practice the Doomsday algorithm. Later I thought that it might be cool not to limit the app to just one skill, but allow extensible architecture. I also didn't want to use any external libraries for argument parsing, so I implemented that myself as well.
 
-- coloured output (termcolor?) with --no-color option
-- additional mode (as many answers in given time)
-- multiple texts for "correct" and "incorrect" answers
-- gitlab & github CI
 
-## What's next & bug reports
+# What's next & bug reports
 
 The application in its current state suits my needs, but I'm open for proposals, either for new skills to practise or more configurability. If you feel that the app lacks something, feel free to open an issue or a PR! I'd be more than happy.
 

README.md

@@ -6,7 +6,7 @@ use std::sync::Arc;
 use crate::args::prelude::*;
 use crate::config::{BehaviourOnError, Config, NumberOfQuestions};
 use crate::question::{Question, Generator};
-// use crate::skill::doomsday_algorithm;
+use crate::skill::doomsday_algorithm;
 use crate::skill::powers;
 use crate::skill::times_table;
 use crate::skill::Skill;
@@ -15,10 +15,10 @@ use crate::stats;
 pub const APP_NAME: &str = env!("CARGO_PKG_NAME");
 const VERSION: &str = env!("CARGO_PKG_VERSION");
 
-const COMMANDS: [help::Command; 2] = [
+const COMMANDS: [help::Command; 3] = [
     help::Command::new(powers::CMD, "Practise powers (configurable base)."),
     help::Command::new(times_table::CMD, "Practise multiplication table."),
-    // help::Command::new(doomsday_algorithm::CMD, "Practise the Doomsday algorithm."),
+    help::Command::new(doomsday_algorithm::CMD, "Practise the Doomsday algorithm."),
 ];
 
 pub struct Application;

src/application.rs

@@ -226,15 +226,15 @@ impl GeneralOptions {
             Arg::builder()
                 .id(ARG_ID_BEHAVIOUR_ON_ERROR)
                 .short_name('b')
-                .long_name("behaviour-on-error")
+                .long_name("behavior-on-error")
                 .description(vec![
                     "Define behaviour on incorrect answer:".to_string(),
                     "(default: showcorrect):".to_string(),
                     "  - continue: proceed to the next question.".to_string(),
-                    "  - showcorrect: proceed to the next" .to_string(),
-                    "    question and display the correct answer." .to_string(),
-                    "  - repeat: ask the question again until" .to_string(),
-                    "    the correct answer is provided." .to_string(),
+                    "  - showcorrect: proceed to the next".to_string(),
+                    "    question and display the correct answer.".to_string(),
+                    "  - repeat: ask the question again until".to_string(),
+                    "    the correct answer is provided.".to_string(),
                 ])
                 .kind(ArgKind::Value(ValueKind::OneOfStr(vec![
                     BEHAVIOUR_ON_ERROR_CONTINUE.to_string(),
@@ -325,7 +325,7 @@ mod tests {
             "command".to_string(),
             "--number-of-questions=10".to_string(),
             "--disable-live-statistics".to_string(),
-            "--behaviour-on-error=repeat".to_string(),
+            "--behavior-on-error=repeat".to_string(),
             "powers".to_string(),
         ];
         let config = Config::build(&args).expect("should build successfully");

src/config.rs

@@ -155,7 +155,7 @@ impl Doomsday {
     fn check_boundaries(
         lower_boundary: i32,
         upper_boundary: i32,
-        arg_definitions: &Vec<Arg>,
+        arg_definitions: &[Arg]
     ) -> Result<bool, String> {
         if lower_boundary > upper_boundary {
             return Err(Self::build_err_message(Some(