Project

General

Profile

1
Installation:
2
    Install: make install
3
        WARNING: This will delete any existing VegBIEN DB!
4
    Uninstall: make uninstall
5
        WARNING: This will delete your VegBIEN DB!
6
    Reinstall all datasources at once: . bin/reinstall_all
7

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

    
16
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
Schema changes:
22
    Regenerate schema from installed DB: make schemas/remake
23
    Reinstall DB from schema: make schemas/reinstall
24
        WARNING: This will delete your VegBIEN DB!
25
    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
        If desired, update the graphical ERD exports (see below)
44
    Update graphical ERD exports:
45
        Go to File > Export > Export as PNG...
46
        Select schemas/vegbien.ERD.png and click Save
47
        Go to File > Export > Export as SVG...
48
        Select schemas/vegbien.ERD.svg and click Save
49
        Go to File > Export > Export as Single Page PDF...
50
        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

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

    
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
(2-2/3)