From 16e4ae1aacbdb54c892c772c552015a9a6ad358f Mon Sep 17 00:00:00 2001 From: Tristan Le Granche Date: Mon, 19 Jun 2023 15:16:37 +0200 Subject: [PATCH] Better readme formatting to make it more readable from IDE --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b66ece12..bef6a882 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # What is EntityLib + **EntityLib** is a library which allow to store and edit complex and huge json data using schemas. + # Top features +- - Use **schemas** to keep your data consistent - Import/**Instantiate**/Reference a json file in an other - **Override** imported data - Generate **strong typed** C++/python class for easy and safe coding - Use **JSON schema** in VSCode for easy/safe manual edition + # How to build ? + ## The easy way + Lets say you doesn't need the python binding or you have only one python installed: - Ensure you have **cmake** installed - Run the **build.bat** file. @@ -15,17 +21,20 @@ Lets say you doesn't need the python binding or you have only one python install - Build **EntityLib** - Build **EntityLibPy** to get the python binding - Build **EntGenAPIGenerator** and run to get the strong typed API + ## The hard way + If you have several python installed and want to choose which one to use. - Ensure you have **cmake** installed and in you environment path - Use cmake-gui or ccmake to configure your project in the directory you want (https://cmake.org/runningcmake/) - Edit options - `PYTHON_INCLUDE_DIR` to point the the include directory inside your python dir - `PYTHON_LIBRARY` to point to the pythonXY.lib inside you python dir - - Generate ! - - Then go in **build** and open **EntityLib.sln**. - - Build **EntityLib** - - Build **EntityLibPy** to get the python binding - - Build **EntGenAPIGenerator** and run to get the strong typed API -You can do this for several python version on the same machine. Just change the target directory. +- Generate ! +- Then go in **build** and open **EntityLib.sln**. +- Build **EntityLib** +- Build **EntityLibPy** to get the python binding +- Build **EntGenAPIGenerator** and run to get the strong typed API + +- You can do this for several python version on the same machine. Just change the target directory.