Skip to content

Better readme formatting to make it more readable from IDE #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Strangenoise wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Better readme formatting to make it more readable from IDE #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,40 @@
# 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.
- 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

## 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.