Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
davewalker5 committed Nov 13, 2023
1 parent a772fee commit cf776f4
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,8 @@ MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train" catalogue

<img src="diagrams/album-search.png" alt="Album Search" width="600">

- Enter the artist name and album title and select the target directory (wish list or main catalogue) then click on "Lookup" to search for the album
- Enter the artist name and album title and select the catalogue to save the album to, either the main catalogue or the wish list
- Click on "Lookup" to search for the album
- If the album is found, the track list for the album is displayed
- The album lookup facility uses the algorithm described under "Album Lookup", below
- Consequently, searching for an album that's not currently in the catalogue will add it to the local database
Expand All @@ -226,13 +227,25 @@ MusicCatalogue.LookupTool --lookup "John Coltrane" "Blue Train" catalogue

### Reports

#### Genre Statistics Report

- To view a summary report by genre, jobs, click on the "Reports > Genre Statistics" menu bar item:

<img src="diagrams/reports-genre-statistics.png" alt="Genre Statistics Report" width="600">

- Use the drop down to select the catalogue to report on, either the main catalogue or the wish list
- If no selection is made, the report is generated for the main catalogue
- Click on the "Search" button to view the results

#### Job Status Report

- To view a report on the status of background export jobs, click on the "Reports > Job Status" menu bar item:

<img src="diagrams/reports-job-status.png" alt="Job Status Report" width="600">

- Use the date pickers to select the start and end dates for the report and click on the "Search" button to view the results
- Use the date pickers to select the start and end dates for the report
- If no dates are selected, all job status records will be returned
- Click on the "Search" button to view the results
- Records are included from 00:00 on the start date up to and including 23:59 on the end date

[^ top](#musiccatalogue)
Expand Down
Binary file modified diagrams/album-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added diagrams/reports-genre-statistics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed wireframes/Example Data.xlsx
Binary file not shown.
12 changes: 12 additions & 0 deletions wireframes/Genre Statistics.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Choral,1,1,15,�18.13
Dance,1,1,13,
Hard Rock,3,3,26,�33.97
Heavy Metal,2,2,17,�19.99
Jazz,11,13,154,�125.60
Latin,1,1,13,�31.95
Pop,2,2,30,�72.97
Progressive Rock,2,2,14,�54.74
Rock,4,6,59,�98.45
Rock & Roll,2,6,92,�236.05
Soul,2,2,27,
Swing,1,1,17,�18.25
Binary file added wireframes/Music Catalogue - v11.00.pdf
Binary file not shown.
Binary file modified wireframes/Music Catalogue.bmpr
Binary file not shown.

0 comments on commit cf776f4

Please sign in to comment.