mrumtl

Describe materials that vary spectrally
git clone git://git.meso-star.fr/mrumtl.git
Log | Files | Refs | README | LICENSE

README.md (1867B)


      1 # ModRadUrb: MaTeriaL
      2 
      3 This C library loads spectrally variable materials saved in mrumtl
      4 format. See `mrumtl.5` for the format specification.
      5 
      6 ## Requirements
      7 
      8 - C compiler
      9 - POSIX make
     10 - pkg-config
     11 - [RSys](https://gitlab.com/vaplv/rsys)
     12 - [mandoc](https://mandoc.bsd.lv)
     13 
     14 ## Installation
     15 
     16 Edit config.mk as needed, then run:
     17 
     18     make clean install
     19 
     20 ## Release notes
     21 
     22 ### Version 0.2
     23 
     24 - Write the man page directly in mdoc's roff macros, instead of using
     25   the intermediate scdoc source.
     26 - Replace CMake by Makefile as build system.
     27 - Update compiler and linker flags to increase the security and
     28   robustness of generated binaries.
     29 - Provide a pkg-config file to link the library as an external
     30   dependency.
     31 
     32 ### Version 0.1
     33 
     34 - Complete rewrite of BRDF accessors. A BRDF is now represented by a
     35   single integer and not directly by a generic data structure. Thus, the
     36   `mrumtl_fetch_brdf` function returns an integer and not a pointer to
     37   the BRDF which is now returned by the new function `mrumtl_get_brdf`.
     38   In addition, data from a specific BRDF is now returned to a data
     39   structure that can therefore store more than one scalar.
     40 - Update of the signature of the `mrumtl_create` function: the input
     41   arguments are now grouped into a variable of type `struct
     42   mrumtl_create_args`. Thanks to this structure and its default value,
     43   updating the input parameters should now marginally affect the calling
     44   code.
     45 - Use scdoc rather than asciidoc as file format for man sources.
     46 
     47 ### Version 0.0.1
     48 
     49 - Bump the CMake minimum version to 3.1. Previously it was set to 2.8
     50   which is deprecated.
     51 
     52 ## Licenses
     53 
     54 Copyright (C) 2020-2023 |Méso|Star> (contact@meso-star.com)
     55 
     56 MruMtl is free software released under the GPL v3+ license: GNU GPL
     57 version 3 or later. You are welcome to redistribute them under certain
     58 conditions; refer to the COPYING file for details.