Fix grammar and spelling

Use notations 'Clang'/'GCC', 'Asciidoctor', 'Make', 'Git', 'CMake' when referring to the tool, not the command

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
Thomas Lauf 2022-08-30 13:27:39 +02:00
parent 9299fd3e39
commit 77fb1851a7
5 changed files with 17 additions and 17 deletions

View file

@ -29,7 +29,7 @@ It is also the quickest way to get help, or confirm a bug.
Review documentation: there are man pages, online articles, tutorials and so on, and these may contain errors, or they may not convey ideas in the best way.
You can help improve it.
Documentation is a separate effort from the codebase, and includes all websites, and all are available using git.
Documentation is a separate effort from the codebase, and includes all websites, and all are available using Git.
Take a look at the bug database, and help triage the bug list.
Bug triage is very useful and much needed.

18
INSTALL
View file

@ -7,13 +7,13 @@ Please follow the instructions below to build and install Timewarrior from sourc
In order to build Timewarrior, you will need:
- cmake (See https://cmake.org)
- make
- asciidoctor (for building documentation)
- CMake (See https://cmake.org)
- Make
- Asciidoctor (for building documentation)
You will need a C++ compiler that supports full C++17, which includes:
- gcc 8
- clang 5
- GCC 8
- Clang 5
# Basic Installation
@ -47,14 +47,14 @@ These commands are explained below:
# Build and configurations options
You can customize the configuration run with cmake variables.
You can customize the configuration run with CMake variables.
This will modify the installation process:
To change the installation directory you use the following configuration variable:
$ cmake -DCMAKE_INSTALL_PREFIX=<path-to-installation-dir> .
cmake configuration variables are applied with the -D option and consist of a <name> and a <value>:
CMake configuration variables are applied with the -D option and consist of a <name> and a <value>:
$ cmake -D<name>=<value> .
@ -81,9 +81,9 @@ The corresponding `TIMEW_*` variables will be combined with `CMAKE_INSTALL_PREFI
# Updating Timewarrior build
This section concerns itself with the description of the procedure needed to update the local Timewarrior build from the 'timew' git repository.
This section concerns itself with the description of the procedure needed to update the local Timewarrior build from the 'timew' Git repository.
To update the local Timewarrior build, you need to update the git repository, including the `src/libshared` submodule.
To update the local Timewarrior build, you need to update the Git repository, including the `src/libshared` submodule.
To do that, run:
$ git pull --recurse-submodules

View file

@ -37,10 +37,10 @@ Thanks to the community, there are binary packages available [here](https://time
Building Timewarrior yourself requires
* git
* cmake (>= 3.8)
* make
* C++ compiler with full C++17 support, currently gcc 8+ or clang 5+
* Git
* CMake (>= 3.8)
* Make
* C++ compiler with full C++17 support, currently GCC 8+ or Clang 5+
* Python 3 (for running the testsuite)
* Asciidoctor (for creating documentation)

View file

@ -332,7 +332,7 @@ bool DatetimeParser::parse_named (Pig& pig)
{
auto checkpoint = pig.cursor ();
// Experimental handling of date phrases, such as "first monday in march".
// Experimental handling of date phrases, such as "first monday in March".
// Note that this requires that phrases are delimited by EOS or WS.
std::string token;
std::vector <std::string> tokens;

View file

@ -146,8 +146,8 @@ std::vector <Interval> expandLatest (const Interval& latest, const Rules& rules)
std::vector <Interval> flattened = flatten (latest, exclusions);
// If flatten() converted the latest interval into a group of synthetic
// intervals, the number of returned intervals will be greater than 1,
// otherwise, it just returned the non-synthetic, latest interval.
// intervals, the number of returned intervals will be greater than 1.
// Otherwise, it just returned the non-synthetic, latest interval.
if (flattened.size () > 1)
{
std::reverse (flattened.begin (), flattened.end ());