updates README, pretty prints name in license file
This commit is contained in:
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 jan.bertram
|
||||
Copyright (c) 2023 Jan Bertram
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
|
||||
21
README.md
21
README.md
@@ -1,3 +1,24 @@
|
||||
# piano_repertoire
|
||||
|
||||
The piano_repertoire-project develops a database to keep track of the pieces a pianist can play, as well as an app to interact with the database. The software is open source and developed under the MIT license.
|
||||
|
||||
## Features
|
||||
|
||||
At the moment, an alpha version is undertaken, with these features:
|
||||
|
||||
### Database
|
||||
|
||||
- The sqlite-database holds a growing number of piano-solo pieces, together with their exact catalogue-numbers and composers.
|
||||
- Prepared in this database is a table for users (pianists), that marks which of the pieces can be played.
|
||||
|
||||
### Application
|
||||
|
||||
- Create new users
|
||||
- Set an active user
|
||||
- (planned) Show the pieces stored in the database
|
||||
- (planned) Mark pieces as masterd for the active user
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.9 or higher
|
||||
- Enough disk space to hold the database
|
||||
Reference in New Issue
Block a user