commit 9d7868ca928fd30d8fe50b9bd1094f277ccd47de
parent b4e8d612d420698343f1f12bb6ae6d8494ab6735
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 27 Jul 2023 17:32:51 +0200
Rewrite the README file
Small changes to the overview. Addition of a section on project
requirements and dependencies. Complete rewrite of the installation
procedure concerning the use of POSIX make instead of CMake as the first
build system.
Diffstat:
| M | README.md | | | 32 | +++++++++++++------------------- |
1 file changed, 13 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -1,31 +1,25 @@
-# Star-Buffer
+# Star Buffer
-Star-Buffer is a C library that loads a buffer stored wrt the Star-Buffer file
-format.
+This C library loads data stored in the sbuf file format (see `sbuf.5` for
+format specification).
-## How to build
+## Requirements
-Star-Buffer is compatible 64-bit POSIX systems. It relies on the
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
-on the [RSys](https://gitlab.com/vaplv/rsys/) library. It optionally depends on
-[scdoc](https://sr.ht/~sircmpwn/scdoc/) which, if available, is used to
-generate the man page of the Star-Mesh file format.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as 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. The
-resulting project can be edited, built, tested and installed as any CMake
-project. Refer to the [CMake](https://cmake.org/documentation) for further
-informations on CMake.
+## Installation
-## Copyright notice
+Edit config.mk as needed, then run:
-Copyright (C) 2022, 2023 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>)
+ make clean install
## License
+Copyright (C) 2022, 2023 |Méso|Star> (contact@meso-star.com)
+
Star-Buffer 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.
