Numbered Titles Sorter

Index

1. Overview
2. Requirements
3. Installation
4. Tests
5. Getting started:

Overview

This repository contains a cli program to sort numbered titles (1., 1.1., 1.1.1, ...) in a text.

Requirements

• System requirements

cargo >= 1.62.1

• Package requirements

Listed in Cargo.toml under '[dependencies]'

Installation

Install it locally via cargo:

cargo install numbered_titles_sorter

Tests

Dowload this repository and run the tests via cargo:

cargo test

Getting started

Install it and run it via cargo:

numbered_titles_sorter.exe <file>

numbered_titles_sorter.exe example_documents/example_1.txt

It will process the given file and write a processed file under the same folder named "processed_"

You can also download this repository and try the cli via cargo:

Type:

cargo run -- <file>

For example:

cargo run -- example_documents/example_1.txt