Change readme
readme has troubleshooting
This commit is contained in:
14
README.md
14
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/<name_of_your_project>/src/main/java/com/<i_dont_know>/<i_dont_know_either>/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/<name_of_your_project>/src/main/java/com/<i_dont_know>/<i_dont_know_either>/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
|
||||
|
||||
<a href="https://github.com/vuminh224"><img src="https://avatars.githubusercontent.com/u/114408235?v=4" title="Tuan Minh VU" width="80" height="80"></a>
|
||||
|
||||
[//]: contributor-faces
|
||||
<a href="https://gitlab.istic.univ-rennes1.fr/alvoisin"><img src="https://secure.gravatar.com/avatar/6f777441aa905b8cb66ff976585a28a648c7bbda3410099cc7cb6e368eb588ff?s=128&d=identicon" title="Alan VOISIN" width="80" height="80"></a>
|
||||
|
||||
Reference in New Issue
Block a user