Project

General

Profile

1 702 aaronmk
Installation:
2
    Install: make install
3
    Uninstall: make uninstall
4 1749 aaronmk
        WARNING: This will delete your VegBIEN DB!
5 1957 aaronmk
    Reinstall all datasources at once: . bin/reinstall_all
6 554 aaronmk
7 702 aaronmk
Data import:
8 1550 aaronmk
    Import data into VegBIEN: . bin/import_all
9 1556 aaronmk
    Stop all running imports: . bin/stop_imports
10 703 aaronmk
    Empty the DB: make empty_db
11 1749 aaronmk
        WARNING: This will delete your VegBIEN DB!
12 1550 aaronmk
    Re-import data: make empty_db; . bin/import_all
13 1749 aaronmk
        WARNING: This will delete your VegBIEN DB!
14 554 aaronmk
15 1773 aaronmk
Datasource setup:
16
    Add a new datasource: make inputs/<short_name>/add
17
        If the datasource is a herbarium, <short_name> should be the herbarium
18
        code as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
19
20 702 aaronmk
Schema changes:
21
    Regenerate schema from installed DB: make schemas/remake
22
    Reinstall DB from schema: make reinstall_db
23 1750 aaronmk
        WARNING: This will delete your VegBIEN DB!
24 702 aaronmk
    Sync ERD with vegbien.sql schema:
25
        Run make schemas/vegbien.my.sql
26
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
27
        Go to File > Export > Synchronize With SQL CREATE Script...
28
        For Input File, select schemas/vegbien.my.sql
29
        Click Continue
30
        Click in the changes list and press Ctrl+A or Apple+A to select all
31
        Click Update Model
32
        Click Continue
33
        Note: The generated SQL script will be empty because we are syncing in
34
            the opposite direction
35
        Click Execute
36
        Reposition any lines that have been reset
37
        Add any new tables by dragging them from the Catalog in the left sidebar
38
            to the diagram
39
        Remove any deleted tables by right-clicking the table's diagram element,
40
            selecting Delete '<table name>', and clicking Delete
41
        Save
42 1774 aaronmk
        If desired, update the graphical ERD exports (see below)
43
    Update graphical ERD exports:
44 702 aaronmk
        Go to File > Export > Export as PNG...
45 1774 aaronmk
        Select schemas/vegbien.ERD.png and click Save
46 702 aaronmk
        Go to File > Export > Export as SVG...
47 1774 aaronmk
        Select schemas/vegbien.ERD.svg and click Save
48 702 aaronmk
        Go to File > Export > Export as Single Page PDF...
49 1774 aaronmk
        Select schemas/vegbien.ERD.pdf and click Save
50
        Go to File > Print...
51
        For Pages, choose From 1 To 1
52
        In the lower left corner, click PDF > Save as PDF...
53
        Set the Title and Author to ""
54
        Select schemas/vegbien.ERD.core.pdf and click Save
55 203 aaronmk
56 1459 aaronmk
Testing:
57
    Mapping process: make test
58
    Map spreadsheet generation: make remake
59 1744 aaronmk
    Missing mappings: make missing_mappings
60 1459 aaronmk
    Everything (for most complete coverage): make test-all
61 702 aaronmk
62
General:
63
    To see a program's description, read its top-of-file comment
64
    To see a program's usage, run it without arguments