From 3f38a9b5f05aadf9a4ad11f7ce558b8e326f04f0 Mon Sep 17 00:00:00 2001 From: Minh VU Date: Fri, 22 Mar 2024 23:11:38 +0100 Subject: [PATCH] Change readme readme has troubleshooting --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0dbe1d9..7ea87ca 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -#Description +##Description This is a project for 3rd year academic of Université de Rennes 1. This project have 3 main parts: DotUML, OpenXAVA and generator based on Python --- > ### Disclaimer -> I use `--Python 3.10` so any superior version or lower will not be tested +> I use `Python 3.10` so any superior version or lower will not be tested > In the code of **Read.py** it could be unusable if there are files has the same name which Python will generate. Please make sure that you have to delete the folder or change the path in **Read.py** --- +## Troubleshooting +* Why I have errors when put others DotUML into your project? + * Normally for easy to use and read file I separate the file for Python to run + * Example: `class Sport{` and and `class Sport {` will be different + * Same as `var:type` and `var : type`. Please change the file into the same format to the code run smoothly. ## Demo * I put a demo of generated code in **tested** folder in case that your machine cannot work. @@ -23,8 +28,8 @@ Avant de cloner/forker ce projet, assurez-vous que les outils suivants sont inst * Install Python 3.10 * Install OpenXava * In OpenXava, you will have to create the package etc to it proprely run. This generator is just make your life easier :) - * After created your own file, copy contents in generated folder into your project. The path folder normally : `--workspace//src/main/java/com///model` - * Then you have to add a line into head of each java file, for example: `--package com.yourcompany.bmo.model;` + * After created your own file, copy contents in generated folder into your project. The path folder normally : `workspace//src/main/java/com///model` + * Then you have to add a line into head of each java file, for example: `package com.yourcompany.bmo.model;` * DotUML will have their own playground that you can check it [here](https://dotuml.com/playground.html) * You copy all text and put in playground to have to connections of all class. @@ -33,5 +38,4 @@ Avant de cloner/forker ce projet, assurez-vous que les outils suivants sont inst -[//]: contributor-faces