commit d6d1bc03023d1fbcf59d09fc5b0390b89c092d4b
parent 4154e74873ecef294463063b50ad2c39112b65c0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 14 Nov 2025 15:18:38 +0100
Update the README file.
Remove the reference to the toolchain in the summary, as it is now an
external project, namely star-typesetting.
Remove the "Overview" section, which essentially repeats the content of
the star-typesetting manual page.
Diffstat:
| M | README.md | | | 87 | ++++++++----------------------------------------------------------------------- |
1 file changed, 8 insertions(+), 79 deletions(-)
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
# Meso-Web
-Sources for the Meso-Star website and toolchain for automatically
-generating it.
+Sources for the Meso-Star website.
## Requirments
@@ -14,10 +13,9 @@ generating it.
- man2html
- [mandoc](https://mandoc.bsd.lv)
- md2html
-- rsync
+- Rsync
- tar
- [tidy](https://www.html-tidy.org/)
-- [shellcheck](https://www.shellcheck.net/) (optionnal)
## Quick Start
@@ -28,85 +26,16 @@ Download resources not directly managed by git:
Edit the config.mk as needed, then run:
- make
- make install # Deploy the website
-
-## Overview
-
-### Structure
-
-The website consists of a set of *sections*.
-The sections are listed in the `menu.tsv` file at the root of the
-repository.
-This is a TSV (Tab Separated Value) file in which each line first
-defines the section label as it will appear in the menu, followed by the
-targeted content.
-
-The sections indexed in the menu can be an external http[s] URL, a
-remote directory managed elsewhere, or, more commonly, a subdirectory of
-the repository.
-In this case, this subdirectory must contain an `index.tsv` file that
-lists the content indexed in the second-level menu.
-As with the `menu.tsv` file, this index is a Tab Separated Value file in
-which each line first defines the submenu label, followed by its target,
-i.e. local content (such as an HTML page) or an http[s] URL.
-This target can be multilingual by using the `@LANG@` macro in its name.
-It will be replaced by one of the languages listed in the third field of
-the line.
-For example, for content available in French and English, the third
-field will have the value `fr:en`.
-This last field is only mandatory in the case of multilingual content.
-Refer to the `misc/index.tsv` file for an example of multilingual
-indexing.
-
-### Content
-
-The website content is defined by section.
-Regular pages are written in
-[Markdown](https://daringfireball.net/projects/markdown/syntax).
-Each .md file in the section's directory is automatically considered
-website content and therefore converted to HTML during automatic website
-generation.
-
-Shell scripts are also automatically detected as site content.
-They are supposed to dynamically generate a Markdown file converted to
-HTML by the build system.
-The resulting file name is that of the script, with the `.sh` extension
-simply replaced by `.html`.
-
-### Additional Resources
-
-The other resources in the section can be stored in three subdirectories
-specific to the section.
-
-- `images` for storing full-size images;
-- `thumbs` for storing thumbnails of images, providing a preview while
- limiting bandwidth and speeding up web page loading;
-- `downloads` for storing other downloadable content, such as archives,
- PDFs, etc.
-
-### Hooks
-
-The `hooks` subdirectory of each section contains shell scripts to be
-executed before the section content is generated.
-Their names must begin with a two-digit priority number that defines
-their order of execution, followed by the character '-'.
-If necessary, they display on standard output the additional files that
-must be deployed with the rest of the site.
-
-Hooks can be used, for example, to convert manual pages to HTML, extract
-the contents of an archive used by section scripts to dynamically
-generate the content of a web page, etc.
-It is ultimately a very versatile mechanism that can be used in many
-ways.
+ make clean
+ make install # Build and deploy the website
## Licences
Copyright © 2017-2025 |Méso|Star> (contact@meso-star.com)
-Generated content is licensed under
-[CC BY-ND 4.0](http://creativecommons.org/licenses/by-nd/4.0/)
-
-The toolchain is free software released under GPL v3+ license: GNU GPL
+This is free software released under GPL v3+ license: GNU GPL
version 3 or later. You are welcome to redistribute it under certain
conditions; refer to the COPYING file for details.
+
+Generated content is licensed under
+[CC BY-ND 4.0](http://creativecommons.org/licenses/by-nd/4.0/)
