Project

General

Profile

« Previous | Next » 

Revision 702

README.TXT: Added instructions to sync ERD with vegbien.sql schema. Organized commands into categories.

View differences:

README.TXT
1
To install: make install
2
To uninstall: make uninstall
3
To reinstall db: make reinstall_db
1
Installation:
2
    Install: make install
3
    Uninstall: make uninstall
4
        Warning: This will delete your VegBIEN DB!
4 5

  
5
To import data into VegBIEN: make import
6
To empty db: make empty_db
6
Data import:
7
    Import data into VegBIEN: make import
8
    Empty db: make empty_db
7 9

  
8
To run tests for each data source: make test2
9
To run unit tests (will eventually be merged into test2 above): make test
10
Schema changes:
11
    Regenerate schema from installed DB: make schemas/remake
12
    Reinstall DB from schema: make reinstall_db
13
    Sync ERD with vegbien.sql schema:
14
        Run make schemas/vegbien.my.sql
15
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
16
        Go to File > Export > Synchronize With SQL CREATE Script...
17
        For Input File, select schemas/vegbien.my.sql
18
        Click Continue
19
        Click in the changes list and press Ctrl+A or Apple+A to select all
20
        Click Update Model
21
        Click Continue
22
        Note: The generated SQL script will be empty because we are syncing in
23
            the opposite direction
24
        Click Execute
25
        Reposition any lines that have been reset
26
        Add any new tables by dragging them from the Catalog in the left sidebar
27
            to the diagram
28
        Remove any deleted tables by right-clicking the table's diagram element,
29
            selecting Delete '<table name>', and clicking Delete
30
        Save
31
        Go to File > Export > Export as PNG...
32
        Select schemas/vegbien.ERD.png
33
        Go to File > Export > Export as SVG...
34
        Select schemas/vegbien.ERD.svg
35
        Go to File > Export > Export as Single Page PDF...
36
        Select schemas/vegbien.ERD.pdf
10 37

  
11
To see a program's description, read its top-of-file comment
12
To see a program's usage, run it without arguments
38
Testing:
39
    Data source tests: make test2
40
    Unit tests (will eventually be merged into test2 above): make test
41

  
42
General:
43
    To see a program's description, read its top-of-file comment
44
    To see a program's usage, run it without arguments

Also available in: Unified diff