Project

General

Profile

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