Project

General

Profile

1
Installation:
2
    Install: make install
3
    Uninstall: make uninstall
4
        WARNING: This will delete your VegBIEN DB!
5

    
6
Data import:
7
    Import data into VegBIEN: . bin/import_all
8
    Stop all running imports: . bin/stop_imports
9
    Empty the DB: make empty_db
10
        WARNING: This will delete your VegBIEN DB!
11
    Re-import data: make empty_db; . bin/import_all
12
        WARNING: This will delete your VegBIEN DB!
13

    
14
Datasource setup:
15
    Add a new datasource: make inputs/<short_name>/add
16
        If the datasource is a herbarium, <short_name> should be the herbarium
17
        code as defined by the Index Herbariorum <http://sweetgum.nybg.org/ih/>
18

    
19
Schema changes:
20
    Regenerate schema from installed DB: make schemas/remake
21
    Reinstall DB from schema: make reinstall_db
22
        WARNING: This will delete your VegBIEN DB!
23
    Sync ERD with vegbien.sql schema:
24
        Run make schemas/vegbien.my.sql
25
        Open schemas/vegbien.ERD.mwb in MySQLWorkbench
26
        Go to File > Export > Synchronize With SQL CREATE Script...
27
        For Input File, select schemas/vegbien.my.sql
28
        Click Continue
29
        Click in the changes list and press Ctrl+A or Apple+A to select all
30
        Click Update Model
31
        Click Continue
32
        Note: The generated SQL script will be empty because we are syncing in
33
            the opposite direction
34
        Click Execute
35
        Reposition any lines that have been reset
36
        Add any new tables by dragging them from the Catalog in the left sidebar
37
            to the diagram
38
        Remove any deleted tables by right-clicking the table's diagram element,
39
            selecting Delete '<table name>', and clicking Delete
40
        Save
41
        If desired, update the graphical ERD exports (see below)
42
    Update graphical ERD exports:
43
        Go to File > Export > Export as PNG...
44
        Select schemas/vegbien.ERD.png and click Save
45
        Go to File > Export > Export as SVG...
46
        Select schemas/vegbien.ERD.svg and click Save
47
        Go to File > Export > Export as Single Page PDF...
48
        Select schemas/vegbien.ERD.pdf and click Save
49
        Go to File > Print...
50
        For Pages, choose From 1 To 1
51
        In the lower left corner, click PDF > Save as PDF...
52
        Set the Title and Author to ""
53
        Select schemas/vegbien.ERD.core.pdf and click Save
54

    
55
Testing:
56
    Mapping process: make test
57
    Map spreadsheet generation: make remake
58
    Missing mappings: make missing_mappings
59
    Everything (for most complete coverage): make test-all
60

    
61
General:
62
    To see a program's description, read its top-of-file comment
63
    To see a program's usage, run it without arguments
(2-2/3)