commit d200c6ab87083a7ea8664a6f6953c41dfaed8ef3 parent bfb3f6f85fa4ec8fdfad5d0a557498fc6f67d17d Author: Vincent Forest <vincent.forest@meso-star.com> Date: Thu, 24 Mar 2022 14:24:29 +0100 Add a README file Diffstat:
| A | README.md | | | 31 | +++++++++++++++++++++++++++++++ |
1 file changed, 31 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,31 @@ +# Star-Buffer + +Star-Buffer is a C library that loads a buffer stored wrt the Star-Buffer file +format. + +## How to build + +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. + +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. + +## Copyright notice + +Copyright (C) 2022 [|Méso|Star>](https://www.meso-star.com) (<contact@meso-star.com>) + +## License + +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.