commit 35615e4f6a0c3b58f14f493729b30d69d97d7a71
parent f66cc60d95f1c5e03393c90d1f95539d5302ff3c
Author: vaplv <vaplv@free.fr>
Date: Tue, 27 Jun 2023 15:57:17 +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:
| M | README.md | | | 44 | ++++++++++++++++++++++---------------------- |
1 file changed, 22 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
@@ -1,30 +1,30 @@
# Loader of the Alias Wafefront obj and mtl file formats
-This C89 code base loads the Alias Wavefront
+AW is a C library whose purpose is to load the Alias Wavefront
[`obj`](http://www.martinreddy.net/gfx/3d/OBJ.spec) and
-[`mtl`](http://www.fileformat.info/format/material/) file formats. Note that
-only a subset of these formats are currently supported.
+[`mtl`](http://www.fileformat.info/format/material/) file formats. Only a
+subset of these formats are currently supported.
-For `obj` files, polygonal primitives with their per vertex position, normal
+For `obj` files, polygonal primitives with their per vertex-position, normal
and texture coordinates are loaded. Smooth, common and material groupings are
-also correctly handled.
-
-For `mtl` files, the ambient, diffuse, specular, glossiness and transmissive RGB
-or XYZ colors are supported. In addition, it loads the refraction index and the
-illumination model. It also handles the ambient, diffuse, specular, glossiness and
-bump textures as well as their attributes (blend< u|v \>, color correction,
-channel mapping, texcoord < offset|scale|turbulence \>, image resolution and bump
-multiplier).
-
-## How to build
-
-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 RSys
-install directories to the `CMAKE_PREFIX_PATH` variable. The resulting project
-can be edited, built, tested and installed as any CMake project.
+also handled correctly.
+
+For `mtl` files, ambient, diffuse, specular, glossiness and transmissive RGB or
+XYZ colors are supported. Additionally, it loads the refraction index and the
+illumination model. The library also loads the filename of ambient, diffuse,
+specular, glossiness and bump textures and their attributes (blend< u|v \>,
+color correction, channel mapping, texcoord < offset|scale|turbulence \>, image
+resolution and bump multiplier).
+
+## Requirements
+
+To build AW, you need RSys header files and library.
+
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
