commit 5a529612326d9af2ac6b47ee4f7db2ea94997c03
parent aa2203f3538761d72a97147434a6f4b3a53bc8fc
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 3 May 2024 18:44:54 +0200
Update the README file
Add "Requirements" and complete rewrite the installation section
regarding the use of a POSIX Makefile and no longer CMake as the first
build system.
Finally wrap the text in 72 columns. This matches the convention of
plain text e-mails. So, it can be sent as a publication announcement
e-mail without being reformatted.
Diffstat:
| M | README.md | | | 81 | +++++++++++++++++++++++++++++++++++++++++++------------------------------------ |
1 file changed, 44 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
@@ -1,33 +1,37 @@
-# Star-Cad
+# Star CAD
-Star-Cad is mostly a wrapper for the gmsh library. It only provides access to
-some of the OpenCascade kernel features, with the benefit of simplified use. One
-of the most valuable features of Star-Cad is that it implements an automated
-reference counting mecanism that eases geometry reference, whilst gmsh system
-of tags doesn't ensure tag persistence accross geometry deletions.
+Star-CAD is mostly a wrapper for the gmsh library. It only provides
+access to some of the OpenCascade kernel features, with the benefit of
+simplified use. One of the most valuable features of Star-CAD is that it
+implements an automated reference counting mecanism that eases geometry
+reference, whilst gmsh system of tags doesn't ensure tag persistence
+accross geometry deletions.
-## 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
-[Gmsh](https://gmsh.info/),
-[RSys](https://gitlab.com/vaplv/rsys/#tab-readme),
-[star-geometry-3d](https://gitlab.com/meso-star/star-geometry-3d) and
-[star-enclosures-3d](https://gitlab.com/meso-star/star-enclosures-3d) libraries.
+- C compiler
+- POSIX make
+- pkg-config
+- [Gmsh](https://gmsh.info/)
+- [RSys](https://gitlab.com/vaplv/rsys)
+- [Star Geometry 3D](https://gitlab.com/meso-star/star-geometry-3d)
+- [Star Enclosures 3D](https://gitlab.com/meso-star/star-enclosures-3d)
-First ensure that CMake is installed on your system. Then install the RCMake
-package as well as all the aforementioned prerequisites. Then generate the
-project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the install directories of its dependencies.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
### Version 0.4.1
-- Add scad_dump_geometry() API call that can be called from a debugging session
+- Add `scad_dump_geometry` API call that can be called from a debugging
+ session
- Remove an invalid assert
-- Fix build that used gmsh library in Release when Debug should have been used
+- Fix build that used gmsh library in Release when Debug should have
+ been used
- Improve logs
### Version 0.4
@@ -44,26 +48,28 @@ project from the `cmake/CMakeLists.txt` file by appending to the
This release largely breaks the API.
- - Add API calls to attach custom data to geometries
- - Increase default min size for generated meshes
- - Add API calls to deals with the entities hidden in geometries
- - Change geometry swap API
- - Remove redundant API calls
- - BugFixes on geometries lifetime management
- - Log messages improvement
- - Many bug fixes
+- Add API calls to attach custom data to geometries
+- Increase default min size for generated meshes
+- Add API calls to deals with the entities hidden in geometries
+- Change geometry swap API
+- Remove redundant API calls
+- BugFixes on geometries lifetime management
+- Log messages improvement
+- Many bug fixes
### Version 0.2
- Introduce reference counting for geometries (API break).
-- Add the scad_stl_data_write API call to write a vector of coordinate as an STL
- file the same way scad_stl_export do (producing the same decimals/bytes).
-- Add scad_stl_get_data and scad_stl_get_data_partial API calls to get the mesh
- of a geometry, allowing to manipulate it before writing it.
-- Add the scad_stl_rxport_partial API call to export part of a geometry to an
- STL file.
+- Add the `scad_stl_data_write` API call to write a vector of coordinate
+ as an STL file the same way `scad_stl_export` do (producing the same
+ decimals/bytes).
+- Add `scad_stl_get_data` and `scad_stl_get_data_partial` API calls to
+ get the mesh of a geometry, allowing to manipulate it before writing
+ it.
+- Add the `scad_stl_export_partial` API call to export part of a
+ geometry to an STL file.
- Remove the reverse arg from STL related functions (API break).
-- Add a scad_geometry_reverse API call.
+- Add a `scad_geometry_reverse` API call.
- Code simplifications in STL-related code
### Version 0.1.0
@@ -72,7 +78,8 @@ Initial version.
## License
-Copyright (C) 2022-2023, 2021 |Meso|Star> (<contact@meso-star.com>).
-Star-Cad is free software released under the GPL v3+ license: GNU GPL
+Copyright (C) 2022 |Méso|Star> (contact@meso-star.com)
+
+Star-CAD 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.
