issue #106 cleanup documentation

.github/workflows/main.yml

@@ -4,9 +4,9 @@ name: Deploy Jekyll & Doxygen GitHub Pages dependencies preinstalled
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["feat/issue106"]
+    branches: [ "develop", "feat/issue106" ]
   pull_request:
-    branches: [ "feat/issue106" ]
+    branches: [ "develop", "feat/issue106" ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -36,18 +36,18 @@ jobs:
         uses: actions/jekyll-build-pages@v1
         with:
           source: ./docs
-          destination: ./docs/_site            
+          destination: ./docs/_site
       - name: Doxygen Action
         uses: mattnotmitt/[email protected]
-        with:          
-          doxyfile-path: ./Doxyfile 
-          working-directory: ./docs 
+        with:
+          doxyfile-path: ./Doxyfile
+          working-directory: ./docs
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: ./docs/_site
-            
-      
+
+
 
   # Deployment job
   deploy:
@@ -57,7 +57,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - name: Deploy to GitHub Pages 
+      - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4        
 

README.md

@@ -15,36 +15,38 @@ tobexyz
 alt="Get it on F-Droid"
 height="80">](https://f-droid.org/packages/de.yaacc/)
 
-<img src="./docs/screenshots/4.1.x/browse_servers.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/browse_image_folder.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/browse_receiver.png" alt= “” width="30%" height="30%">
-<img src="./docs/screenshots/4.1.x/music_player.png" alt= “” width="30%" height="30%"> <img src="./docs/screenshots/4.1.x/playlist_fully_editable.png" alt= “” width="30%" height="30%"> <img src="./docs/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)
-
+* 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!
 
@@ -68,4 +70,3 @@ After the build has finished the debug apk is located in
 ## Documentation
 
 <https://tobexyz.github.io/yaacc-code>
-

docs/index.md

@@ -25,13 +25,13 @@ On the first screen all UPnP/DLNA servers in your network are listed.
 Select one and the app will automatically switch to the content tab.
 It allows to browse the content provided by the selected server.
 
-![browse_servers](./screenshots/4.1.x/browse_servers.png){:height="30%" width="30%"}
+![browse_servers](./screenshots/4.2.x/browse_servers.png){:height="30%" width="30%"}
 
 Before selecting content make sure you have chosen an receiver on
 the receiver tab. Receivers are either UPnP/DLNA media renderers in
 your network or the android device itself.
 
-![browse_receiver](./screenshots/4.1.x/browse_receiver.png){:height="30%" width="30%"}
+![browse_receiver](./screenshots/4.2.x/browse_receiver.png){:height="30%" width="30%"}
 
 Normally senders and receivers will appear automatically.
 If not you can use the refresh button at the bottom of
@@ -49,7 +49,7 @@ Behind each content entry different symbols are showing the possible actions:
 
 At the bottom of the screen the currently selected sender and receiver is displayed.
 
-![browse_music_folder](./screenshots/4.1.x/browse_music_folder.png){:height="30%" width="30%"}
+![browse_music_folder](./screenshots/4.2.x/browse_music_folder.png){:height="30%" width="30%"}
 
 ## Playing content
 
@@ -61,22 +61,22 @@ smart speaker at the same time.
 Each player is displayed in the player tab. Depending on the content type
 and if the content is played by YAACC itself or a network device, the player ui differs.
 
-![browse_player](./screenshots/4.1.x/browse_player.png){:height="30%" width="30%"}
+![browse_player](./screenshots/4.2.x/browse_player.png){:height="30%" width="30%"}
 
 YAACC includes a player for music and image shows.
 Videos are played using a third parties app on the device.
 The video app will start automatically, if video content is selected for playing
 
-![music_player](./screenshots/4.1.x/music_player.png){:height="30%" width="30%"}
+![music_player](./screenshots/4.2.x/music_player.png){:height="30%" width="30%"}
 
-![image_player_show_menu](./screenshots/4.1.x/image_player_show_menu.png){:height="30%" width="30%"}
+![image_player_show_menu](./screenshots/4.2.x/image_player_show_menu.png){:height="30%" width="30%"}
 
 ## Media server
 
 YAACC includes a media server service, which has to be enabled separately.
 A switch for this is located at the bottom of the server list tab.
 
-![browse_servers](./screenshots/4.1.x/browse_servers.png){:height="30%" width="30%"}
+![browse_servers](./screenshots/4.2.x/browse_servers.png){:height="30%" width="30%"}
 
 Depending on the configurations for the server in the settings,
 the server service is used as media provider, media renderer or proxy.