Merge pull request #114 from tobexyz/feat/issue106

Feat/issue106

.github/workflows/main.yml

@@ -0,0 +1,63 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll & Doxygen GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [ "develop", "feat/issue106" ]
+  pull_request:
+    branches: [ "develop", "feat/issue106" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./docs/_site
+      - name: Doxygen Action
+        uses: mattnotmitt/[email protected]
+        with:
+          doxyfile-path: ./Doxyfile
+          working-directory: ./docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_site
+
+
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment_site.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4        
+

.gitignore

@@ -1,3 +1,10 @@
+doxygen
+.bundle
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
 .metals
 .vscode
 .envrc

README.md

@@ -15,37 +15,38 @@ tobexyz
 alt="Get it on F-Droid"
 height="80">](https://f-droid.org/packages/de.yaacc/)
 
-<img src="./doc/screenshots/4.1.x/browse_servers.png" alt= “” width="30%" height="30%"> <img src="./doc/screenshots/4.1.x/browse_image_folder.png" alt= “” width="30%" height="30%"> <img src="./doc/screenshots/4.1.x/browse_receiver.png" alt= “” width="30%" height="30%">
-<img src="./doc/screenshots/4.1.x/music_player.png" alt= “” width="30%" height="30%"> <img src="./doc/screenshots/4.1.x/playlist_fully_editable.png" alt= “” width="30%" height="30%"> <img src="./doc/screenshots/4.1.x/image_player_show_menu.png" alt= “” width="30%" height="30%">
+<img src="./docs/screenshots/4.2.x/browse_servers.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/browse_image_folder.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/browse_receiver.png" alt= “” width="30%" height="30%">
+<img src="./docs/screenshots/4.2.x/music_player.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/playlist_fully_editable.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.2.x/image_player_show_menu.png" alt= “” width="30%" height="30%">
 
 ## Description
 
-The App allows you to play media from UPNP/DLNA devices in your network on your android device or
-any capable UPNP device in your network. It is also possible to start an UPNP server on your device
-in order to play media from your device on any UPNP renderer in your network.
+The App allows you to play media from UPnP/DLNA devices in your network on your android device or
+any capable UPnP device in your network. It is also possible to start an UPnP server on your device
+in order to play media from your device on any UPnP renderer in your network.
 
 ## Features
 
-* UPNP Server - share files of your device in the network
-* UPNP Client - receive media from other devices on your device
-* UPNP Controller - control media renderer in the network
+* UPnP/DLNA Server - share files of your device in the network
+* UPnP/DLNA Client - receive media from other devices on your device
+* UPnP/DLNA Controller - control media renderer in the network
 * Control multiple media renderer
 * Allow download files to the device
-* Allow sharing of urls and sending them to the current media renderers
-* Implemented parts of UPnP Version 3 at once (sending synchronization information to the renderer)
-
-[Screenshots](./doc/screenshots/screenshots.md)
+* Allow sharing of URLs and sending them to the current media renderers
+* Use your device as an proxy if your media renderer can't process https media URLs
 
 ## Configuration
-Please take a look in the settings of the app. A lot of configuration can be done there. 
 
-The media server is stopped by default and has to be activiated in the settings. 
-For this go to settings and tick some checkboxes under "Local server configuration" depending on your needs in order to start the server
+Please take a look in the settings of the app. A lot of configuration can be done there.
 
+The media server is stopped by default and has to be activated in the settings.
+For this go to settings and tick some checkboxes under "Local server configuration" depending
+on your configuration needs. You can start the server by activating the corresponding setting
+or by activating the switch at the bottom of the server tab
 
 ## A word about the cling library
 
-This project is based on the work of <https://github.com/4thline/cling>. This great UPNP library made
+This project is based on the work of <https://github.com/4thline/cling>. This great UPnP library
+made
 yaacc possible and all honor belongs to the authors of that project. Thank you for your work on that
 project!
 
@@ -66,6 +67,6 @@ Build the project by running following command in the project root:
 After the build has finished the debug apk is located in
 ```./yaacc/build/outputs/apk/debug/yaacc-debug.apk```
 
-## the old sf wiki
+## Documentation
 
-[wiki](./wiki/YaaccWiki.md)
+<https://tobexyz.github.io/yaacc-code>