From 5a84114057282c9001e3f2cacb567926a0952b7b Mon Sep 17 00:00:00 2001
From: Felipe Olmos <luisfelipe.olmosmarchant@orange.com>
Date: Fri, 13 Oct 2023 16:39:24 +0200
Subject: [PATCH] Update readme

---
 README.md                                   | 70 ++++++---------------
 packaging/common/images/new_khiops_logo.svg |  1 +
 2 files changed, 20 insertions(+), 51 deletions(-)
 create mode 100644 packaging/common/images/new_khiops_logo.svg

diff --git a/README.md b/README.md
index beb7f9c7e..ccef55273 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,27 @@
-# Khiops project
+<img src=https://github.com/khiopsML/khiops/blob/93-update-the-readme-for-the-beta-release/packaging/common/images/new_khiops_logo.svg width=100 />
+<!--<img src=https://github.com/khiopsML/khiops/blob/main/packaging/common/images/new_khiops_logo.svg width=100 />-->
 
-# Compilation
+# Khiops
+Khiops is an AutoML suite for supervised and unsupervised learning
 
-```bash
-mkdir build
-cmake -B build -S . -DMPI=ON -DFULL=OFF -DBUILD_JARS=ON -DTESTING=OFF -DCMAKE_BUILD_TYPE=Release
-cmake --build build/ --parallel
-```
+# Installation
+For the installation instructions [go to Khiops website][khiops-install].
 
-# Packaging
+# Documentation
+See the documentation [at the Khiops website][khiops-web]
 
-## CPack: deb, rpm and zip
+# Development
+See the [developer's documentation wiki][wiki-dev].
 
-The different packages are built with cpack. The used generators are:
+# License
+This software is distributed under the BSD 3-Clause-clear License, the text of which is available at
+https://spdx.org/licenses/BSD-3-Clause-Clear.html or see the [LICENSE](./LICENSE) for more
+details.
 
-- DEB for debian
-- ZIP for KNI on windows
-- RPM for redhat
+# Help Contact
+khiops.team@orange.com
 
-Run the following command to launch the packaging. The resulting packages are located on `build/packages`.
 
-```bash
-cd build
-cpack -G DEB
-```
-
-On Fedora-like distro, the environment module mpi must be loaded before configure, build and package processes:
-
-```bash
-source /etc/profile.d/modules.sh
-module load mpi/mpich-x86_64
-mkdir build && cd build
-cmake -B . -S .. -DMPI=ON -DFULL=OFF -DBUILD_JARS=ON -DTESTING=OFF -DCMAKE_BUILD_TYPE=Release
-cmake --build . --parallel
-cpack -G RPM
-```
-
-### CPack TODOs
-
-- test packaging on macOS with `cpack -G FreeBSD`. It should work (we just have to get kni and khiops-sample out from the install)
-- test NSIS on windows (`cpack -G NSIS64`)
-- rewiew the KNI doc (the same one for Linux and Windows)
-- change the package name to include the disto version on DEB and RPM
-- Questions:
-  - remove packaging/common/khiops/doc/*.docx
-  - remove packaging/common/khiops/doc/KhiopsTutorial.pptx
-  - remove packaging/common/khiops/whatsnewV9.0.1.txt
-
-## Conda
-
-The package version is not imported from the source (TODO) then, we have to set the environment variable `KHIOPS_VERSION` before building the package.
-
-```bash
-# extract package version from sources
-set KHIOPS_VERSION=$(grep "KHIOPS_VERSION" src/Learning/KWUtils/KWKhiopsVersion.h | cut -d"(" -f2 | cut -d")" -f1)
-# build package
-conda-build packaging/conda/
-```
+[khiops-web]: https://khiops.org
+[khiops-install]: https://khiops.org/setup/installation
+[wiki-dev]: https://github.com/KhiopsML/khiops/wiki
diff --git a/packaging/common/images/new_khiops_logo.svg b/packaging/common/images/new_khiops_logo.svg
new file mode 100644
index 000000000..bbbe14c58
--- /dev/null
+++ b/packaging/common/images/new_khiops_logo.svg
@@ -0,0 +1 @@
+<svg width="1820" height="1815" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" overflow="hidden"><g transform="translate(-1292 -330)"><g><rect x="1293" y="330" width="1815" height="1815" fill="#FF7900" fill-opacity="1"/><path d="M1451 1960 2200 669 2949 1960Z" fill="#FFFFFF" fill-rule="evenodd" fill-opacity="1"/></g></g></svg>
\ No newline at end of file