From 62cdbdb08995580c45451ada4ee14fdcfcd421e8 Mon Sep 17 00:00:00 2001
From: "Glenn Y. Rolland" <glenux@glenux.net>
Date: Sun, 2 Jun 2024 21:21:50 +0200
Subject: [PATCH] docs: add missing information to README

---
 README.md | 54 +++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 35 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 2ffdd91..bc4cd24 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,53 @@
-# DocMachine (Utils)
+# DocMachine Cli
 
-DocMachine is a CLI tool designed to simplify the process of creating technical documentation and presentations. 
+DocMachine Cli is a tool designed to simplify the process of creating technical
+documentation and presentations.
 
 ## Motivation
 
 This project aims to address the following challenges:
 
-* **Automation:** Automate the generation of high-quality technical content, including documentation and presentation slides.
-* **Consistency:** Ensure a consistent and polished look and feel across all content pieces.
-* **Efficiency:** Reduce the time and effort required to produce content by leveraging AI tools.
+* **Automation:** Automate the generation of high-quality technical content,
+  including documentation and presentation slides.
+* **Consistency:** Ensure a consistent and polished look and feel across all
+  content pieces.
+* **Efficiency:** Reduce the time and effort required to produce content by
+  leveraging AI tools.
 
 ## Features
 
 DocMachine offers a range of features to streamline the content creation process:
 
-* **Scaffolding:** Generate a well-structured project directory with all the necessary files.
-* **Building:** Compile and publish your content as HTML and PDF documents using Dockerized build processes.
+* **Scaffolding:** Generate a well-structured project directory with all the
+  necessary files.
+* **Building:** Compile and publish your content as HTML and PDF documents
+  using Dockerized build processes.
 
 We are actively developing the following features for future releases:
 
-* **Planning:** Leverage LLMs (Large Language Models) to generate content outlines tailored to your specific needs and requirements.
-* **Writing:** Utilize LLMs to draft content for each section and subsection, saving you valuable time and effort.
+* **Planning:** Leverage LLMs (Large Language Models) to generate content
+  outlines tailored to your specific needs and requirements.
+* **Writing:** Utilize LLMs to draft content for each section and subsection,
+  saving you valuable time and effort.
 
 ## Prerequisites
 
-FIXME: list prerequisites for crystal lang & dependencies
+You'll need a recent version of Crystal (>= 1.11.0) to use this project.
+
+You'll also need to install a few dependencies:
+
+* libreadline-dev
+* libncurses-dev
 
 ## Getting Started
 
-Follow these steps to start using DocMachine:
+Follow these steps to start using DocMachine Cli:
 
 ### Installation
 
 ```bash
-git clone https://code.apps.glenux.net/glenux/docmachine-utils.git docmachine-utils
-cd docmachine-utils
+git clone https://code.apps.glenux.net/glenux/docmachine-cli.git docmachine-cli
+cd docmachine-cli
 make build
 make install
 ```
@@ -42,13 +55,14 @@ make install
 ### Create a New Project
 
 ```bash
-docmachine scaffold my-doc-project 
+docmachine scaffold my-documentation-project
 ```
 
-This command will create a new directory named `my-doc-project` with the following structure:
+This command will create a new directory named `my-documentation-project` with
+the following structure:
 
 ```
-my-doc-project
+my-documentation-project
 ├── _build
 ├── docs
 │   └── images  # link to ../images
@@ -60,7 +74,8 @@ my-doc-project
 ### Start Writing Content
 
 * **Documentation:** Place your Markdown files inside the `docs` directory.
-* **Presentations:** Place your Markdown files (using Marp syntax) inside the `slides` directory.
+* **Presentations:** Place your Markdown files (using Marp syntax) inside the
+  `slides` directory.
 * **Images:** Store your images in the respective `images` directories.
 
 ### Live-reload during writing
@@ -70,6 +85,7 @@ docmachine build -a watch
 ```
 
 This command will start a Docker container and build your documentation and presentations:
+
 * **Documentation:** Built using MkDocs and served on `http://localhost:5100`.
 * **Presentations:** Built using Marp and served on `http://localhost:5200`.
 
@@ -100,6 +116,6 @@ We welcome contributions to DocMachine! To contribute:
 
 ## License
 
-DocMachine is licensed under the GPL-3.0-or-later license. See the `LICENSE`
-file for details.
+DocMachine Cli is licensed under the GPL-3.0-or-later license. See the
+`LICENSE` file for details.