commit 219bd6244dc2223d0da58a40a650c2162ee2585d
parent 6c75e72ffad21329d99e156bb46ff3c777b077a7
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 26 Apr 2024 18:59:33 +0200
Update README file
Replace the "How to build" section with the "Requirements" and
"Installation" sections, which indicate the use of a POSIX Makefile
rather than CMake as the build system.
Wraps text on 72 columns to match the convention of plain text e-mails.
It can therefore be sent as a publication announcement e-mail whithout
being reformatted.
Diffstat:
| M | README.md | | | 52 | ++++++++++++++++++++++++---------------------------- |
1 file changed, 24 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
@@ -1,37 +1,32 @@
-# sgreen
+# Stardis Green
-## Overview
+Stardis Green is a postprocess of Green function binary files, as
+produced by the [Stardis](https://gitlab.com/meso-star/stardis) program.
+Its main purpose is to compute Monte Carlo results by applying Green
+functions to new settings, enabling ultra-fast Monte Carlo computations.
-sgreen is a postprocess of Green function binary files, as produced by the
-*stardis* program (https://gitlab.com/meso-star/stardis). The main purpose
-of sgreen is to compute Monte-Carlo results by applying Green functions to
-new settings, enabling ultra-fast Monte-Carlo computations.
+## Requirements
-## How to build
+- C compiler with OpenMP support
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Stardis](https://gitlab.com/meso-star/stardis)
-Sgreen relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) package to build.
-It also depends on the
-[RSys](https://gitlab.com/vaplv/rsys/) library as well as on the
-[OpenMP](http://www.openmp.org) 2.0 specification to parallelize its
-computations. Finally, sgreen depends on the header file in
-[Stardis-green-types](https://gitlab.com/meso-star/stardis.git) to define
-the format of its input files.
+## Installation
-First ensure that CMake and a C compiler that implements the OpenMP 2.0
-specification are installed on your system. Then install the RCMake package as
-well as all the aforementioned prerequisites. Finally generate the project from
-the `cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH`
-variable the install directories of its dependencies.
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
### Version 0.4
- Change input file format to cope with stardis changes.
-- Now depends on the stardis-green-types.h header file, that is installed
- when building stardis and describes the types used to read and write Green
- function binary files. Currently depends on version 4.
+- Now depends on the stardis-green-types.h header file, that is
+ installed when building stardis and describes the types used to read
+ and write Green function binary files. Currently depends on version 4.
### Version 0.3
@@ -57,12 +52,13 @@ Fix a bug that could cause a crash.
- Compatible with stardis v0.5.0 binary Green function files.
- Can produce a summary of a Green function in HTML format.
-- Can apply a Green function to new settings and output the corresponding Monte-Carlo results.
+- Can apply a Green function to new settings and output the
+ corresponding Monte Carlo results.
## License
-Copyright (C) 2020-2022 |Meso|Star> (<contact@meso-star.com>). Stardis-Green is
-free software released under the 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.
+Copyright (C) 2020-2022 |Méso|Star> (contact@meso-star.com).
+Stardis-Green is free software released under the 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.
