readme: Add initial information
authorLokesh Vutla <lokeshvutla@ti.com>
Sat, 24 Aug 2019 15:32:07 +0000 (21:02 +0530)
committerLokesh Vutla <lokeshvutla@ti.com>
Mon, 26 Aug 2019 03:55:11 +0000 (09:25 +0530)
Add initial README file

Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com>
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..cc1eba8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+###############################################################################
+#                                                                             #
+#                                   K3CONF                                    #
+#                                                                             #
+#    A Powerful Diagnostic Tool for Texas Instruments K3 based Processors     #
+###############################################################################
+
+
+
+INTRODUCTION:
+-------------
+
+K3CONF is a Linux user-space standalone application designed to provide a
+quick'n easy way to dynamically diagnose Texas Instruments' K3 architecture
+based processors. K3CONF is intended to provide similar experience to that of
+OMAPCONF that runs on legacy TI platforms.
+
+**WARNING**: This is work in progress! Don't expect things to be complete in any
+dimension. Use at your own risk. And keep the reset button in reach.
+
+
+
+SUPPORT:
+--------
+
+K3CONF currently supports AM654 and J721E Devices. Legacy OMAP and DRA7
+platforms are not supported.
+
+
+
+Build Instructions:
+-------------------
+
+To build the output binary file run the following command:
+
+       # make CROSS_COMPILE=aarch64-linux-gnu-
+
+Copy the output binary "k3conf" to your Filesystem.
+
+That's it!!
+
+
+
+Help:
+-----
+
+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.