Skip to content

Commit 9760f5a

Browse files
committed
Add README, screenshots
1 parent d485e98 commit 9760f5a

File tree

5 files changed

+45
-1
lines changed

5 files changed

+45
-1
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 Julien Poitrin
3+
Copyright (c) 2018 Poitrin
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Covers app
2+
This app has been developed for musicians who …
3+
* know which instruments (synths, samples, …) have been used (or can be used) in a song (piece, …) and want to share this information with other musicians
4+
* E.g. I know that the [synth sound of the intro of Coldplay’s song Hypnotised](https://www.youtube.com/watch?v=WXmTEyq5nXc) can be obtained from a [Yamaha keyboard, with the preset “Stardust”](https://www.youtube.com/watch?v=QwKxPuqxJvI).
5+
* play in a cover band and need to find sounds that are similar to the original sound
6+
* E.g. I have a Yamaha Motif XF8 synth and my band wants to cover Bon Jovi’s _It’s my life_. Which sounds do I need to select (what do I need to configure) in order to be close to the original?
7+
8+
## User Interface
9+
### List all creative works (songs, pieces, …)
10+
![List all creative works](https://raw.github.com/Poitrin/covers/master/doc/images/creative_work_list.png)
11+
12+
### Create a new creative work
13+
![Create a new creative work](https://raw.github.com/Poitrin/covers/master/doc/images/creative_work_create.png)
14+
15+
### Get sound suggestions of a specific song
16+
![Get sound suggestions of a specific song](https://raw.github.com/Poitrin/covers/master/doc/images/creative_work_show.png)
17+
18+
## Installation
19+
(still needs to be written)
20+
21+
## Testing
22+
(still needs to be written)
23+
24+
## Design decisions
25+
(still needs to be written)
26+
27+
## To do / ideas
28+
### General
29+
- [ ] Execute all tests via Travis CI (configure test DB, …)
30+
- [ ] Consistently use 2 spaces (instead of 4)
31+
- [ ] Convert source code TODOs into Github issues
32+
- [ ] Deploy the app so that it is public for all musicians in the world
33+
- [ ] Input boxes are maybe too small sometimes and should be replaced by a textarea
34+
- [ ] Admin login to approve incoming data
35+
- [ ] Edit or delete own information
36+
- [ ] Search functionality
37+
- [ ] Be able to add sources (e.g. forums, videos, …)
38+
- [ ] Generate documentation
39+
40+
### Tests that need to be written
41+
- [ ] When no creative works have been created, the "New creative work" button should not be displayed twice
42+
- [ ] The current user should only see approved information (by an admin) or his / her own published information waiting for approval
43+
- [ ] Creative works, parts and suggestions should be correctly ordered by creation date (desc or asc)
44+
- [ ] Validation errors should be correctly displayed / translated

doc/images/creative_work_list.png

128 KB
Loading

0 commit comments

Comments
 (0)