Skip to content

Enhance README.md with project overview and algorithm details #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomconder merged 1 commit into from
Sep 15, 2025
Merged

Enhance README.md with project overview and algorithm details #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# linebreak

A simple app to demonstrate line-breaking algorithms.
A Go library demonstrating line-breaking algorithms with optimal text formatting.


## Overview

This project implements two line-breaking algorithms to format text within specified width constraints:

- **Greedy Algorithm**: Fast, simple approach that fits as many words as possible on each line
- **Knuth-Plass Algorithm**: Sophisticated dynamic programming solution that optimizes line breaks based on penalty functions

## Features

- **Multiple Algorithms:** Choose between greedy and Knuth-Plass line breaking
- **Dynamic Programming:** Efficiently computes optimal line breaks. It uses a penalty for trailing spaces to promote balanced text.
- **Unit Tested:** Includes unit tests to ensure quality and to allow future changes with confidence.

Expand Down