commit 45efaf4e4fe641178b0359fad202ed7575ac6b6e
parent 2ed56a13917f76ecff75b5af5eb92f274698baeb
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 13 Jul 2023 17:46:39 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project, actually just the RSys
library. And complete rewrite of the installation procedure regarding
the use of a POSIX Makefile and no longer CMake.
Diffstat:
1 file changed, 15 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
# Star STereo Lithography
-This library loads stl file formats. Currently, only the stl ASCII format is
-supported.
+Star-STL loads STL file format
-## How to build
+## Requirements
-The library uses [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build. It also
-depends on the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) library.
-First, install the RCMake package and the RSys library. Then, generate the
-project from the cmake/CMakeLists.txt file by appending the RCMake and the RSys
-install directories to the `CMAKE_PREFIX_PATH` variable. The resulting project
-can be edited, built, tested and installed as any CMake project.
+C compiler (C99), POSIX make, pkg-config, and
+[RSys](https://gitlab.com/vaplv/rsys/) header files and library.
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -42,8 +42,9 @@ Correction of a compilation error highlighted in particular by GCC 4.9.2
## License
-Copyright (C) 2015, 2016, 2019, 2021, 2023 |Méso|Star>
-(<contact@meso-star.com>). Star-STL is free software released under the
-CeCILLv2.1 license. You are welcome to redistribute it under certain
-conditions; refer to the COPYING files for details.
+Copyright (C) 2015, 2016, 2019, 2021, 2023 |Méso|Star> (contact@meso-star.com)
+
+Star-STL is free software released under the CeCILLv2.1 license. You are
+welcome to redistribute it under certain conditions; refer to the COPYING
+files for details.
