Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
foxcaulfield committed Dec 23, 2023
1 parent fc7374d commit dd979be
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,42 @@
# lorem-gen
Lorem Ipsum console generator

## Program Description

This program generates random paragraphs of Lorem Ipsum text based on the specified number of paragraphs and sentences. It's a fun way to generate placeholder text for your projects or experiments.

## How to Use

To use the lorem-gen program, follow these steps:

1. Clone the repository to your local machine.
2. Compile the program using CMake.
3. Run the program with two command-line arguments: the number of paragraphs and the number of sentences per paragraph.

Here's an example command to run the program:

```
./lorem-gen 2 3
```

This command will generate 2 paragraphs, each containing 3 sentences.

## Example Output

Running the program with the command `./lorem-gen 2 3` will produce the following output:

```
Lorem ipsum dolor sit amet. Consectetur adipiscing elit. Mauris condimentum.
Lacus in placerat commodo. Libero felis pulvinar orci. Eget interdum orci quam vel enim.
Curabitur id orci eu tortor ullamcorper lacinia. Curabitur turpis orci. Consectetur vitae iaculis a.
```

## Dependencies

The program requires CMake version 3.20.0 or higher and a C++20 compatible compiler.

## License

This program is licensed under the MIT License. See the LICENSE file for more information.

0 comments on commit dd979be

Please sign in to comment.