https://github.com/mcb2003/gc

Grammar Corrector - A simple C project to fix common issues with text.
https://github.com/mcb2003/gc

c cli commandline full-stop grammar period whitespace

Last synced: about 1 year ago
JSON representation

Grammar Corrector - A simple C project to fix common issues with text.

• Host: GitHub
• URL: https://github.com/mcb2003/gc
• Owner: mcb2003
• License: gpl-3.0
• Created: 2020-10-30T21:50:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-24T23:18:29.000Z (over 5 years ago)
• Last Synced: 2025-02-13T09:31:43.766Z (over 1 year ago)
• Topics: c, cli, commandline, full-stop, grammar, period, whitespace
• Language: C
• Homepage:
• Size: 39.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gc - Grammar Corrector

This started out of an idea spawned by a question on an exam paper that

asked me to write an algorithm to automatically capitalise letters at the

beginning of sentences. I took the algorithm I came up with a bit further,

transformed the pseudocode into C, and this was the result.

The code is pretty well commented (some might even say over-commented), in part

because I'm just getting to grips with C myself for anything approaching a

"project", and in part because I'd like to show this to people who may not

have learned C, ormore likely don't know about things like ANSI terminal

escape codes, the standard streams, etc.

## Features

* Automatically capitalises the first letter of sentences (only if they start with a letter)

* Collapses any excessive white-space to a single space character

* Completely trims off white-space at the start of the text

* Reads from files given as command-line args (or stdin), writes to standard output

## Compiling

All you need to do is run `make` for a debug build, or `make release` for

a release build. You can also run `make clean` to clean up generated object

files and the binary itself.

## Usage

Just run `gc `, where filename is the name of a file you'd like to fix. For example:

**test.txt:**

    this is   a test  file.        it's not very well      written.

    that's the point.

    

    here's another        paragraph.

```sh

./gc test.txt

```

**Output:**

    This is a test file. It's not very well written.

    That's the point.

    Here's another paragraph.

For complete help and usage examples, run `./gc --help`:

    Usage:

            ./gc # Read from STDIn

            ./gc file1|-[ file2|-[ ...]]

    ./gc - Grammar Corrector  Copyright (C) 2020  Michael Connor Buchan

    Corrects grammar and punctuation, and collapses white-space in each of the input

    files, outputting to STDOUT by default.