Commit dfc12280 authored by Simon Kirsten's avatar Simon Kirsten
Browse files

Updated documentation

parent 87c15f01
Pipeline #22291 failed
## Changelog
### 0.9.0 <small>_August 21, 2019_</small>
* Initial Release
\ No newline at end of file
# Contributing
**TODO: talk about:**
* gitlab
* issues
* pull requests
* code quality
* tests
* gitlab CI
* recommended dev environment
\ No newline at end of file
# License
**TODO: Discuss license**
**MIT License**
Copyright (c) 2019
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 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.
# Stream TV Project
[![pipeline status](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/badges/master/pipeline.svg)](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/commits/master)
[![coverage report](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/badges/master/coverage.svg)](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/commits/master)
<!-- [![pipeline status](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/badges/master/pipeline.svg)](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/commits/master) -->
<!-- [![coverage report](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/badges/master/coverage.svg)](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/commits/master) -->
### [Documentation](https://simons-nzse-2.h-da.io/stream-tv)
<!-- ### [Documentation](https://simons-nzse-2.h-da.io/stream-tv) -->
**TODO**
\ No newline at end of file
# Stream TV Project
<!-- Insert LICENSE.md from the root -->
--8<-- "README.md"
<!-- # Stream TV Project
!!! example "*TODO*"
* The documentation is written in mixed german and english. I should decide on one.
......@@ -18,4 +23,4 @@ Das Projekt ist ein direkter Nachfolger des [TV Servers](https://lernen.h-da.de/
- [About](about/index.md): Meta-dokumentation.
!!! info
Für das Praktikum ist das lesen der kompletten Dokumentation nicht nötig. Vorallem das Kapitel [About](about/index.md) ist vorallem für interne Zwecke gedacht.
\ No newline at end of file
Für das Praktikum ist das lesen der kompletten Dokumentation nicht nötig. Vorallem das Kapitel [About](about/index.md) ist vorallem für interne Zwecke gedacht. -->
\ No newline at end of file
......@@ -6,7 +6,7 @@
* die dokumentation ist viel weiterreichend als (für die studis) notwendig
The following System Design doesn't fit here and is just a plain copy paste from the old wiki.
<!-- **The following System Design doesn't fit here and is just a plain copy paste from the old wiki.**
### System Proposal with a local backend (comparable to the existing TV Server).
......@@ -17,7 +17,7 @@ The following System Design doesn't fit here and is just a plain copy paste from
- *Backend* forwards controls from the *App* to the *Website*.
- *Website* displays Twitch stream(s).
![SystemProposal1.svg](/assets/SystemProposal1.svg)
![system-proposal-1.svg](../assets/system-proposal-1.svg)
### System Proposal with no local backend. The backend is then provided by us in the cloud / fbi-network for everybody.
This is similar to the other proposal, but this time only a single backend exists and is shared between all the users. To differentiate between different users – tokens need to be used.
......@@ -29,4 +29,4 @@ This is similar to the other proposal, but this time only a single backend exist
- *Backend* forwards controls from the *App* to the *Website*.
- *Website* displays Twitch stream(s).
![SystemProposal2.svg](/assets/SystemProposal2.svg)
\ No newline at end of file
![system-proposal-2.svg](../assets/system-proposal-2.svg) -->
\ No newline at end of file
# Remote
<small>TODO</small>
\ No newline at end of file
**TODO**
\ No newline at end of file
# Contributing
!!! example "*TODO: talk about*"
* gitlab
* issues
* pull requests
* code quality
* tests
* gitlab CI
* recommended dev environment
\ No newline at end of file
<!-- Insert CONTRIBUTING.md from the root -->
--8<-- "CONTRIBUTING.md"
......@@ -2,20 +2,16 @@
## Download
OS | CPU Platform | Download
--- | --- | ---
Windows | x86 (64-bit) | [stream-tv-server-windows-x86_64.exe](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-windows-x86_64.exe?job=server)
&nbsp;| x86 (32-bit) | [stream-tv-server-windows-x86.exe](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-windows-x86.exe?job=server)
Linux | x86 (64-bit) | [stream-tv-server-linux-x86_64](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-linux-x86_64?job=server)
&nbsp;| x86 (32-bit) | [stream-tv-server-linux-x86](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-linux-x86?job=server)
&nbsp;| ARM (64-bit) | [stream-tv-server-linux-arm64](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-linux-arm64?job=server)
&nbsp;| ARM (32-bit) | [stream-tv-server-linux-arm32](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-linux-arm32?job=server)
Darwin (macOS) | x86 (64-bit) | [stream-tv-server-darwin-x86_64](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-darwin-x86_64?job=server)
&nbsp;| x86 (32-bit) | [stream-tv-server-linux-x86](https://code.fbi.h-da.de/simons-nzse-2/stream-tv/-/jobs/artifacts/master/raw/stream-tv-server-darwin-x86?job=server)
!!! tip
In the following documentation the specific executable e.g. `stream-tv-server-windows-x86_64.exe` is always refered to as `stream-tv-server`.
For simplicity's sake you should also rename your executable to `stream-tv-server` or `stream-tv-server.exe` (on Windows).
OS | CPU Platform | Download
--------------- | --------------------- | ----------------------------------------------------------------------
Windows | x86 (64-bit) | [stream-tv-server](../binaries/darwin-x86/stream-tv-server)
&nbsp; | x86 (32-bit) | [stream-tv-server](../binaries/darwin-x86_64/stream-tv-server)
Linux | x86 (64-bit) | [stream-tv-server](../binaries/linux-x86/stream-tv-server)
&nbsp; | x86 (32-bit) | [stream-tv-server](../binaries/linux-x86_64/stream-tv-server)
&nbsp; | ARM (64-bit) | [stream-tv-server](../binaries/linux-arm/stream-tv-server)
&nbsp; | ARM (32-bit) | [stream-tv-server](../binaries/linux-arm64/stream-tv-server)
Darwin (macOS) | x86 (64-bit) | [stream-tv-server.exe](../binaries/windows-x86/stream-tv-server.exe)
&nbsp; | x86 (32-bit) | [stream-tv-server.exe](../binaries/windows-x86_64/stream-tv-server.exe)
??? expert info
If you do not wish to use a precompiled executable you can [compile it yourself](contributing.md).
......@@ -27,7 +23,7 @@ Darwin (macOS) | x86 (64-bit) | [stream-tv-server-darwin-x86_64](https://code.f
2. *Optional:* Provide [command-line options](options.md).
!!! warning
If you get [this](/assets/windows-protected-your-pc.png) *"Windows proteced your PC"* warning press <kbd>More info</kbd> and <kbd>Run anyway</kbd>.
If you get [this](../assets/windows-protected-your-pc.png) *"Windows proteced your PC"* warning press <kbd>More info</kbd> and <kbd>Run anyway</kbd>.
### Linux
1. Assign the file execute permission in a terminal: `chmod +x stream-tv-server`.
......
# License
!!! example "*TODO*"
We should really have a license but idk if MIT is the right one and who actually has copyright here...
**MIT License**
<!-- Copyright &copy; 2019 Simon Kirsten -->
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 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 NON-INFRINGEMENT. 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
<!-- Insert LICENSE.md from the root -->
--8<-- "LICENSE.md"
......@@ -41,7 +41,6 @@ Returns: [`Game`](#game) array.
---
### `/twitch/games/search`
<small>TODO: fix this</small>
> Searches games by query.
Query String Parameter:
......@@ -50,6 +49,8 @@ Query String Parameter:
| --------------- | ------ | --- |
| `query` | string | What should be searched e.g. `query=Talk%20Shows` |
---
### `/twitch/streams/top`
> Gets the most popular streams on twitch right now. Optionally filter by channels, game and language.
......@@ -85,7 +86,7 @@ Returns: [`Stream`](#stream) array.
---
## Structures <small>(by Example)</small>
## JSON Structures <small>(by Example)</small>
### TVState
``` json
......
......@@ -4,9 +4,5 @@
To upgrade the Stream TV Server to the latest version just replace the executable with the newest from [Downloads](/server/#download).
## Changelog
### 0.0.1 <small>_August 6, 2019_</small>
* Something
* Something else
\ No newline at end of file
<!-- Insert CHANGELOG.md from the root -->
--8<-- "CHANGELOG.md"
......@@ -71,6 +71,7 @@ markdown_extensions:
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
......@@ -95,7 +96,7 @@ nav:
- Remote:
- Remote: remote/index.md
- Test Page: remote/testpage.md
# - Test Page: remote/testpage.md
- About:
......
Supports Markdown
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