commit 9b54a95dbea27f8558e5467d8cd446c023dbd311
parent ab4a3a4f63b95cf6b2e761aa4aa8ff08997a203b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 27 Jul 2023 15:58:12 +0200
Rewrite the README file
Small changes to the overview. Addition of a section on project
requirements and dependencies. Complete rewrite of the installation
procedure concerning the use of POSIX make instead of CMake as the first
build system.
Diffstat:
| M | README.md | | | 35 | ++++++++++++++++++----------------- |
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
@@ -1,19 +1,20 @@
-# Star-Camera
+# Star Camera
-Star-Camera is C library whose purpose is to simulate camera model.
+This C library implements camera models such as pinhole, thin lens and
+orthographic projection.
-## How to build
+## Requirements
-Star-Camera relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
-on the [RSys](https://gitlab.com/vaplv/rsys/) library.
+- C compiler
+- POSIX make
+- pkg-config
+- [RSys](https://gitlab.com/vaplv/rsys)
-First ensure that CMake is installed on your system. Then install the RCMake
-package and the RSys library. Finally generate the project from the
-`cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH` variable
-the install directories of its dependencies. The resulting project can be
-edited, built, tested and installed as any CMake project. Refer to the
-[CMake](https://cmake.org/documentation) for further informations on CMake.
+## Installation
+
+Edit config.mk as needed, then run:
+
+ make clean install
## Release notes
@@ -23,8 +24,8 @@ Add the `scam_perspective_get_solid_angle` function.
## License
-Copyright (C) 2021-2023 [|Méso|Star>](https://www.meso-star.com)
-(<contact@meso-star.com>). Star-Camera 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.
+Copyright (C) 2021-2023 |Méso|Star> (contact@meso-star.com)
+
+Star-Cam 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.
