commit e1b3a09b5dd455e4e575591f22f7d696dd909d8f
parent 9f4fa8a5a1a584e597cb4102391b1044a2bf10fa
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 17 Jul 2023 11:16:33 +0200
Rewrite the README file
Cleanup and small rewrite of the preview. Add a requirements section
that lists the dependencies of the project. And complete rewrite of the
installation procedure regarding the use of a POSIX Makefile and no
longer CMake.
Diffstat:
| M | README.md | | | 36 | ++++++++++++++++-------------------- |
1 file changed, 16 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,25 +1,20 @@
# Star 3D shapes from STereo Lithography geometries
-This library creates Star-3D shapes from geometries saved in the stl
-fileformats.
+Star-3DSTL creates [Star-3D](https://gitlab.com/meso-star/star-3d) shapes from
+triangulated geometries saved in STL file format.
+
+## Requirements
+
+C compiler, POSIX make, pkg-config, and the header files and libraries of
+[RSys](https://gitlab.com/vaplv/rsys),
+[Star-3D](https://gitlab.com/meso-star/star-3d) and
+[Star-STL](https://gitlab.com/meso-star/star-stl).
## How to build
-This library depends on the
-[Star-STL](https://gitlab.com/meso-star/star-stl/#tab-readme) library to load
-Stereo Lithography files and on the
-[Star-3D](https://gitlab.com/meso-star/star-3d/#tab-readme) library to define
-the in-core representation of the loaded shapes. It also uses
-[CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/#tab-readme) package to build and
-depends on the [RSys](https://gitlab.com/vaplv/rsys/#tab-readme) library.
-
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as the RSys, STL and Star-3D libraries. Finally generate the
-project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of the previously defined
-dependencies. The generated project can be edited, built, tested and installed
-as any CMake project.
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -30,8 +25,9 @@ obsolete.
## License
-Copyright (C) 2015-2018, 2021 |Meso|Star> (<contact@meso-star.com>). Star-3DSTL is
-free software released under CeCILLv2.1 license. You are welcome to
-redistribute it under certain conditions; refer to the COPYING files for
+Copyright (C) 2015-2018, 2021 |Meso|Star> (contact@meso-star.com)
+
+Star-3DSTL is free software released under CeCILLv2.1 license. You are welcome
+to redistribute it under certain conditions; refer to the COPYING files for
details.
