commit be9893758408cd3d5851ea8ff81bfc0c45b11d42
parent 4c460c5f48ac0487abc0a818defa451820881af7
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Tue, 10 Feb 2026 15:58:22 +0100
Improve project description in the README
Describe the different components of the star-phor-input project
(file format specification, C library, and utility programs), providing
a high-level overview of each and removing details that are already
covered in the man pages, where they are better suited.
Make minor improvements to the requirements section, such as specifying
the required C standard and adding hyperlinks to dependency repositories
where applicable. Fix minor typos and remove the duplicated
"uninstallation" section.
Diffstat:
| M | README.md | | | 40 | +++++++++++++++------------------------- |
1 file changed, 15 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
@@ -1,28 +1,26 @@
# star-phor-input
-**star-phor-input** is a C library designed to parse input files compatible
-with the [star-phor](star-phor) solver. It loads the corresponding data into
-memory as a scene that describes a photoreactive system.
+**star-phor-input** is a file format convention for describing photoreactor
+configurations in photoreactive system engineering. It comes with a dedicated C
+library and a linter. The star-phor-input file format specification is used as
+the input for the star-phor solver, which depends on the sphin library.
-The library has the following properties:
+**sphin** is a C library designed to parse star-phor-input configuration files
+and access the associated data. Thanks to an unstructured scene description, the
+memory representation is independent of any specific numerical method used to
+solve the system. This makes the library solver-agnostic while still providing
+all necessary geometries and physical properties for computation.
-- **Unified Data Representation**
-The library abstracts all data formats on disk while loading the data. For
-example, geometries are all stored in a consistent structure—primarily using
-one-dimensional arrays—regardless of their original file format.
-
-- **Unstructured Scene Description**
-The scene representation is independent of any specific numerical method used
-for solving the system. This makes the library solver-agnostic, while still
-providing all the necessary geometries and physical properties for computation.
+**sphin-lint** is an executable that flags syntactic errors, bugs, stylistic
+issues, and suspicious constructs in star-phor-input configuration files.
## Requirements
- POSIX make
-- C compiler
+- C compiler (C99)
- pkg-config
-- rsys
-- star-stl
+- [RSys](https://gitlab.com/vaplv/rsys/)
+- [star-stl](https://gitlab.com/meso-star/star-stl/)
- scdoc
## Installation
@@ -31,7 +29,7 @@ Edit config.mk as needed. Run:
make all
-Then run :
+Then run:
make install
@@ -45,14 +43,6 @@ Run:
with appropriate privileges.
-## Uninstallation
-
-Run:
-
- make uninstall
-
-with approprate privileges.
-
## Copyright notice
Copyright (C) 2024-2026 Centre National de la Recherche Scientifique
