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
    Archive the last import: make schemas/rotate
12
    Re-import data: make schemas/rotate; . bin/import_all
13
        Note: This will archive the last import.
14
    Empty the DB: make schemas/reinstall
15
        WARNING: This will delete your VegBIEN DB!
16

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

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

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

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