Verified Commit 2076b2ae authored by Stephan Fischer's avatar Stephan Fischer
Browse files

Update readme and restructured license

parent b948e1ce
......@@ -2,16 +2,20 @@ The MIT License (MIT)
Copyright (c) 2015-2017 Stephan Fischer (tocsin.de, stephan-fischer.de)
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:
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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Used scripts
Flask (https://github.com/pallets/flask) (Armin Ronacher and contributors, BSD License)
Video.js (https://github.com/videojs/video.js) (Brightcove Inc, Apache License 2.0)
videojs-youtube (https://github.com/videojs/videojs-youtube) (Benoit Tremblay, MIT License)
videojs-vimeo (https://github.com/videojs/videojs-vimeo) (Benoit Tremblay, MIT License)
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
\ No newline at end of file
......@@ -16,18 +16,16 @@ Got YouTube playlists with 100+ songs and a thirst for exploring something new?
## System requirements
newsic's backend is based on Python 3 and the [Flask](https://github.com/pallets/flask) framework, while the frontend uses [Video.js](https://github.com/videojs/video.js) (which comes bundled with this repository).
Flask (and Jinja2 and Werkzeug) can either be installed with your favorite package manager or with `pip install -r requirements.txt`.
newsic's backend is based on Python 3 and the [Flask](https://github.com/pallets/flask) framework, while the frontend uses [Video.js](https://github.com/videojs/video.js) (which comes bundled with this repository). Required Python packages are listed in the [requirements.txt](/requirements.txt).
## Usage
1. Clone this repository
1. Clone this repository and navigate to the folder where you cloned it to
2. Create a config.py from config.py.example
2. Add your YouTube API key (which you can request
3. Add your YouTube API key (which you can request
[here](https://console.developers.google.com/apis/api/youtube/)) to config.py
3. Navigate to the folder where you cloned the code and start newsic with `python3 newsic.py` (or only `python newsic.py` when you use Arch Linux)
4. newsic is now available at 127.0.0.1:5000
4. Install the requirements with either `pip install -r requirements.txt` or your favorite package manager
5. Start newsic with `python3 newsic.py` (or only `python newsic.py` when you use Arch Linux), which is now available at 127.0.0.1:5000
### Deployment
......@@ -51,7 +49,14 @@ Shortcut | What will happen (hopefully)
MIT License, Copyright (c) 2015-2017 Stephan Fischer ([tocsin.de](https://tocsin.de), [stephan-fischer.de](https://stephan-fischer.de))
For more details see [LICENSE.md](/LICENSE.md).
For more details see [LICENSE](/LICENSE).
## Used scripts
* [Flask](https://github.com/pallets/flask) (Armin Ronacher and contributors, BSD License)
* [Video.js](https://github.com/videojs/video.js) (Brightcove Inc, Apache License 2.0)
* [videojs-youtube](https://github.com/videojs/videojs-youtube) (Benoit Tremblay, MIT License)
* [videojs-vimeo](https://github.com/videojs/videojs-vimeo) (Benoit Tremblay, MIT License)
## Donate
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment