From: Mazet Laurent <laurent.mazet@thalesgroup.com>
Date: Fri, 4 Jul 2025 07:25:39 +0000 (+0200)
Subject: add install file
X-Git-Tag: v1.0
X-Git-Url: https://secure.softndesign.org/git/?a=commitdiff_plain;h=c394ca138f0f0879dc2e628a56a86341c649b1e5;p=morep.git

add install file
---

diff --git a/install.md b/install.md
new file mode 100644
index 0000000..b04755a
--- /dev/null
+++ b/install.md
@@ -0,0 +1,53 @@
+# MOREP, Messaging Over Raw Ethernet Packet
+
+The MOREP library eases the management of the raw Ethernet socket. 
+
+## Requirements
+
+This library only need a C compiler to be build.
+
+## Install
+
+- Build binaries and libraries
+  make
+- Install binaries in $DESTDIR/bin
+  sudo DESTDIR=/usr/local/ make install_exe
+- Install libraries in $DESTDIR/lib and includes in $DESTDIR/includes
+  sudo DESTDIR=/usr/local/ make install_lib
+
+## Tests
+
+- Do static code analysis
+  make analyze
+- Execute tests
+  sudo make tests
+- Execute tests and evaluate converage
+  sudo make gcovs
+- Execute tests and check memory management
+  sudo make valgrinds
+
+## Cleaning
+
+- Remove residual files froms compilation and testings
+  make clean
+- Also remove binary and library produced
+  make purge
+- Also remove coverage file repors
+  make wipe
+
+## Cross compilation
+
+- Build dynamically linked binaries
+  CC=arm-linux-gnueabihf-gcc AR=arm-linux-gnueabihf-ar make
+- Build statically linked binaries
+  CC=arm-linux-gnueabihf-gcc AR=arm-linux-gnueabihf-ar LDOPTS=-static make
+
+## Limitations
+
+Raw Ethernet sockets need root privilege. That's why all testing rule calls
+have to be preceede by 'sudo'.
+
+## Changelogs
+
+MOREP v1.0 (Fri, 04 Jul 2025)
+- initial version