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
        Using column-based import: . bin/with_all 'import by_col=1'
11
    Stop all running imports: . bin/stop_imports
12
    Archive the last import: make schemas/rotate
13
    Re-import data: make schemas/rotate; . bin/import_all
14
        Note: This will archive the last import.
15
    Empty the DB: make schemas/reinstall
16
        WARNING: This will delete your VegBIEN DB!
17

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

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

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

    
65
Documentation:
66
    To generate a Redmine-formatted list of steps for column-based import:
67
        make inputs/QMOR/import/steps.by_col.sql
68

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