Skip to content

rjwignar/ctil

Repository files navigation

ctil

"Today I learned" Markdown authoring command-line tool written in C++

This is a command-line tool that processes .txt files into .html files

User Installation

Download the latest release

The latest version of ctil can be installed using the latest GitHub release. Left-click the latest release on the right-hand side of the repository page: image

Left-click the ctilvX.Y.Z.zip to download the program. image

The zip file will contain the program executable file (ctil.exe). For convenience, save the zip file to the directory containing your .txt and/or .md files:

image

Extract

Once the zip file has been downloaded, navigate to the directory and extract the zip file using your file decompression software of choice (E.g. WinRAR, gunzip):

image

ctil.exe will now be available in your directory for use.

Open your terminal of choice

Since ctil is a command-line tool, you must have this directory open in a terminal (such as Windows PowerShell) to use it. For Windows 10 and above: One way to do this is to enter 'powershell' in the search bar of the file explorer with your directory open: image

Once the terminal is open, you can refer to the Usage Examples below on how to run ctil.

Usage Examples

Converting one file (.txt or .md): .\ctil.exe test.txt or .\ctil.exe markdown_test.md

Convert all text files in a directory .\ctil.exe testDirectory

More Info About Markdown Support

Now, this tool can also accept Markdown files as input. You can use the same method to acquire and run the tool.

Currently, in the most recent version, only Italics formatting is supported. Additional features will be included in future updates.

WARNING If you have files with the same name, e.g., same-name.txt and same-name.md in a single input folder, the output will generate only one HTML file based on the content of the Markdown file.

Planned Features

Version Flag .\ctil.exe -v, .\ctil.exe --version

Help Flag .\ctil.exe -h, .\ctil.exe --help

Output Flag (specifies destination folder for HTML files) .\ctil.exe -o destination test.txt, .\ctil.exe --output destination test.txt