diff --git a/README.md b/README.md
index 95704d6f94ca0260a716cd5b16a7d3dbd811443d..145a60da8552d281c844742c703021017ad000d1 100644 (file)
--- a/README.md
+++ b/README.md
-###############################################################################
-# #
-# K3CONF #
-# #
-# A Powerful Diagnostic Tool for Texas Instruments K3 based Processors #
-###############################################################################
-
+K3CONF
+======
+A Powerful Diagnostic Tool for Texas Instruments K3 based Processors
INTRODUCTION:
INTRODUCTION:
dimension. Use at your own risk. And keep the reset button in reach.
dimension. Use at your own risk. And keep the reset button in reach.
-
SUPPORT:
--------
SUPPORT:
--------
-K3CONF currently supports AM654, J721E, J7200 and AM64x Devices. Legacy OMAP and DRA7
-platforms are not supported.
-
+K3CONF currently supports AM654, J721E, J7200, AM64x, AM62x, J721S2, J784S4,
+J722S, AM62Ax and AM62Px devices. Legacy OMAP and DRA7 platforms are not supported.
+This tool makes usage of /dev/mem. If your kernel doesn't have CONFIG_DEVMEM,
+or enables CONFIG_DEVMEM_STRICT_IO, it will not work well.
Build Instructions:
-------------------
Build Instructions:
-------------------
-To build the output binary file run the following command:
+* Install build dependencies (Debian based example):
+
+ # sudo apt install build-essential cmake
+
+* If cross-compiling, install and set your cross-compiler:
+
+ # sudo apt install gcc-aarch64-linux-gnu
+ # export CC=aarch64-linux-gnu-gcc
+
+* To build the output binary file run the following commands:
+
+ # mkdir build
+ # cd build
+ # cmake ..
+ # make
+
+* Copy the output binary `k3conf` to your Filesystem. That's it!!
- # make CROSS_COMPILE=aarch64-linux-gnu-
-Copy the output binary "k3conf" to your Filesystem.
+Build Instructions for static linked binary:
+--------------------------------------------
-That's it!!
+* The default k3conf binary generated is with shared library, alternatively to
+ build a static linked binary replace the `cmake` command in build
+ instructions with below command.
+ # cmake .. -Dstatic_exe=ON
Help:
-----
Help:
-----
-Type "./k3conf --help" to get complete list of available commands and options.
+* Type `./k3conf --help` to get complete list of available commands and options.
Note that in case of incorrect command/option, help will also be displayed.
Note that in case of incorrect command/option, help will also be displayed.