To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 27dfe54d authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Minor updates in the README for the DB documentation

parent 4e152268
......@@ -11,14 +11,13 @@ A Python script to generate documentation from MySQL Workbench ERR diagram. This
## Usage
An example output of the Nexus-e database can be found at [nexus-e-database.md](nexus-e-database.md).
An example output of the Nexus-e database can be found at [documentation-example.md](documentation-example.md).
### Generate documentation from ERR digram
* Open the ERR digram
* Navigate to menu **Tools** > **Utilities** > **Generate Documentation (Markdown)**
* When you see the status bar text changed to *Documentation generated into the clipboard. Paste it to your editor.*, Paste (<kbd>Ctrl</kbd> + <kbd>V</kbd> in most Linux/Window applications) to your editor and save as a new file.
* Name the new file as `nexus-e-database.md` and store it in the folder **docs/sources**.
* When you see the status bar text changed to *Documentation generated into the clipboard. Paste it to your editor.*, paste to (i.e., **overwrite**) the file `docs/sources/nexus-e-database.md`.
### Generate ERR digram from physical database
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment