GitBook: [#13] Description & Gifs

SaicharanKandukuri · gitbook-bot · commit 8fef107788cb · 2021-11-14T13:19:24.000Z
diff --git a/.gitbook/assets/CatTypingGIF.gif b/.gitbook/assets/CatTypingGIF.gif
diff --git a/.gitbook/assets/GrimDanceGIF.gif b/.gitbook/assets/GrimDanceGIF.gif
diff --git a/.gitbook/assets/JustShakeItOff,ShakeItOffGIF.gif b/.gitbook/assets/JustShakeItOff,ShakeItOffGIF.gif
diff --git a/.gitbook/assets/MehMondayGIF.gif b/.gitbook/assets/MehMondayGIF.gif
diff --git a/.gitbook/assets/TipsAndTricksTutorialsGIF.gif b/.gitbook/assets/TipsAndTricksTutorialsGIF.gif
diff --git a/README.md b/README.md
@@ -1,38 +1,36 @@
 ---
-description: details & description
+description: udroid Documentation & details
 cover: >-
   https://images.unsplash.com/photo-1629654297299-c8506221ca97?crop=entropy&cs=srgb&fm=jpg&ixid=MnwxOTcwMjR8MHwxfHNlYXJjaHw0fHxsaW51eHxlbnwwfHx8fDE2MzU4NTk1Njc&ixlib=rb-1.2.1&q=85
 coverY: 0
 ---
 
 # 🐧 udroid
 
-![a rendered image showing udroid ubuntu mate desktop environment running on smartphone ](<.gitbook/assets/banner (1).jpg>)
+![a rendered image showing udroid ubuntu mate desktop environment running on smartphone](<.gitbook/assets/banner (1).jpg>)
 
 ### Ubuntu-21.04 on android
 
 Ubuntu-on-android aims to run ubuntu with pre-installed Desktop Environment, development tools, and software on top of android without root with the help of proot in termux application. This project is just like any other Linux on android projects but with aim of making it easy for end-user on setting up Linux.
 
-&#x20;![img2](https://badges.frapsoft.com/os/v1/open-source.svg?v=103) [![Support Server](https://img.shields.io/discord/892727774828199976?color=blue\&label=join%20%23udroid\&logo=discord\&logoColor=white\&style=for-the-badge)](https://discord.gg/h7wZ9BfbU9) [![Join the chat at https://gitter.im/ubuntu-on-android/community](https://badges.gitter.im/ubuntu-on-android/community.svg)](https://gitter.im/ubuntu-on-android/community)[![CodeFactor](https://www.codefactor.io/repository/github/randomcoderorg/ubuntu-on-android/badge)](https://www.codefactor.io/repository/github/randomcoderorg/ubuntu-on-android)
+![img2](https://badges.frapsoft.com/os/v1/open-source.svg?v=103) [![Support Server](https://img.shields.io/discord/892727774828199976?color=blue\&label=join%20%23udroid\&logo=discord\&logoColor=white\&style=for-the-badge)](https://discord.gg/h7wZ9BfbU9) [![Join the chat at https://gitter.im/ubuntu-on-android/community](https://badges.gitter.im/ubuntu-on-android/community.svg)](https://gitter.im/ubuntu-on-android/community)[![CodeFactor](https://www.codefactor.io/repository/github/randomcoderorg/ubuntu-on-android/badge)](https://www.codefactor.io/repository/github/randomcoderorg/ubuntu-on-android)
 
 codename = `udroid`
 
 ### Supported arch status
 
-| arch   | status                                                                                                                               |
-| ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
-| arm64  | ![stat](https://img.shields.io/badge/-installable-brightgreen)                                                                       |
-| armv7l | <mark style="color:orange;"></mark>![stat](https://img.shields.io/badge/-installable-brightgreen)<mark style="color:orange;"></mark> |
-| armv8l | ![stat](https://img.shields.io/badge/-partially%20supported-orange)                                                                  |
-| amd64  | ![](https://img.shields.io/badge/-inprogress-blue)                                                                                   |
-| Others | `not started`                                                                                                                        |
-
+| arch   | status                                                              |
+| ------ | ------------------------------------------------------------------- |
+| arm64  | ![stat](https://img.shields.io/badge/-installable-brightgreen)      |
+| armv7l | ![stat](https://img.shields.io/badge/-installable-brightgreen)      |
+| armv8l | ![stat](https://img.shields.io/badge/-partially%20supported-orange) |
+| amd64  | ![](https://img.shields.io/badge/-inprogress-blue)                  |
+| Others | `not started`                                                       |
 
 ### Some Screenshot
 
-![screenshot showing udroid with pre-installed xfce4 using libreoffice draw app](.gitbook/assets/three.png) ![screenshot showing udroid with pre-installed xfce4 using vscode and glxgeras running ](<.gitbook/assets/four (1).png>) ![screenshot showing ubuntu mate](<.gitbook/assets/IMG\_20211014\_084106 (1).jpg>)
+![screenshot showing udroid with pre-installed xfce4 using libreoffice draw app](.gitbook/assets/three.png) ![screenshot showing udroid with pre-installed xfce4 using vscode and glxgeras running](<.gitbook/assets/four (1).png>) ![screenshot showing ubuntu mate](<.gitbook/assets/IMG\_20211014\_084106 (1).jpg>)
 
- 
 ### Developers & credits
 
 DEV #0 = [Saicharankandukuri](https://github.com/SaicharanKandukuri)
diff --git a/udroid-landing/basic-usage.md b/udroid-landing/basic-usage.md
@@ -1,18 +1,25 @@
-### Basic Usage
-  | **Command**        | **Usage** |
-  |--------------------|-----------|
-  | `udroid`            | To login to shell |
-  |  `udroid upgrade` | to upgrade fs or to get new features if available |
-  | `startvnc`   | start vncserver at port `1` (you can change default port by exporting env varaible `DEFAULT_VNC_PORT` to a port number) |
-  | `udroid stopvnc`    | stop vncserver at given or default port `1`
-  | `udroid --enable-dbus` | To start udroid with dbus hack enabled |
-  | `udroid --enable-dbus-vnc` | To start vnc session with dbus hack enabled |
+---
+description: udroid command line options for basic usage
+---
 
-## Environment Variables
-- `DEFAULT_VNC_PORT` to set vnc port for scripts
-- `HIPPO_BRANCH` to set custom branch for cloning code
+# 👩‍💻 Basic Usage
+
+| **Command**                | **Usage**                                                                                                               |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `udroid`                   | To login to shell                                                                                                       |
+| `udroid upgrade`           | to upgrade fs or to get new features if available                                                                       |
+| `startvnc`                 | start vncserver at port `1` (you can change default port by exporting env varaible `DEFAULT_VNC_PORT` to a port number) |
+| `udroid stopvnc`           | stop vncserver at given or default port `1`                                                                             |
+| `udroid --enable-dbus`     | To start udroid with dbus hack enabled                                                                                  |
+| `udroid --enable-dbus-vnc` | To start vnc session with dbus hack enabled                                                                             |
+
+**Environment Variables**
+
+* `DEFAULT_VNC_PORT` to set vnc port for scripts
+* `HIPPO_BRANCH` to set custom branch for cloning code
+
+## Alt way to login
 
-#### Alt way to login
 ```bash
 proot-distro login udroid --bind /dev/null:/proc/sys/kernel/cap_last_cap
 ```
diff --git a/udroid-landing/credits.md b/udroid-landing/credits.md
@@ -1,2 +1,9 @@
 # 💳 Credits
 
+{% hint style="info" %}
+LOT TO WRITE ✌️
+
+work in progress
+{% endhint %}
+
+![devolopers on work be like!](../.gitbook/assets/CatTypingGIF.gif)
diff --git a/udroid-landing/fixing-firefox-sound.md b/udroid-landing/fixing-firefox-sound.md
@@ -1,3 +1,7 @@
+---
+description: guide for fixing sound in Firefox
+---
+
 # 🦊 Fixing Firefox Sound
 
 Well if you're trying to play youtube or any other web music player inside firefox in it, probabily sound will not work even though PulseAudio is running. It can be fixed easily, just follow the below steps.
diff --git a/udroid-landing/hardware-acceleration.md b/udroid-landing/hardware-acceleration.md
@@ -1,6 +1,8 @@
-# 📺 Hardware Acceleration
+---
+description: achieving HW acceleration in termux
+---
 
-#### Important Note
+# 📺 Hardware Acceleration
 
 {% hint style="warning" %}
 This is fully experimental and not finalized in termux-x11 release yet. You might face glitches or rendering issues with it. Or full app crash on open
diff --git a/udroid-landing/playing-games.md b/udroid-landing/playing-games.md
@@ -1,3 +1,7 @@
+---
+description: games in termux proot
+---
+
 # 🎮 Playing Games
 
 Well its possible to run games in it, just follow the [hardware acceleration](hardware-acceleration.md). Small games like Neverball, SuperTuxKart works impressively. Here is some gameplay.
diff --git a/udroid-landing/quick-installation-and-usage.md b/udroid-landing/quick-installation-and-usage.md
@@ -1,13 +1,13 @@
 ---
-description: Installation
+description: this is how you can install udroid in termux
 ---
 
-# 📖 Quick Installation and usage
+# 📖 Installation & Usage
 
 ### Before installing:-
 
 * Get termux from [termux.com](https://termux.com) or [F-Droid.](https://f-droid.org/en/packages/com.termux/)
-* [Vnc Viewer](https://play.google.com/store/apps/details?id=com.iiordanov.freebVNC), [Xserver XSDL](https://play.google.com/store/apps/details?id=x.org.server) or [Termux:X11](https://GitHub.com/termux/termux-x11) for Display 
+* [Vnc Viewer](https://play.google.com/store/apps/details?id=com.iiordanov.freebVNC), [Xserver XSDL](https://play.google.com/store/apps/details?id=x.org.server) or [Termux:X11](https://github.com/termux/termux-x11) for Display
 
 #### Video tutorial
 
@@ -24,9 +24,12 @@ bash install.sh
 udroid --install
 ```
 
-#### Uninstalling 
+#### Uninstalling
+
 For uninstalling rootfs you can use
+
 ```bash
 proot-distro remove udroid
 ```
+
 Downloaded Tarballs are stored in `$PREFIX/var/lib/proot-distro/dlcache`, you can remove it too.
diff --git a/udroid-landing/setting-up-gui.md b/udroid-landing/setting-up-gui.md
@@ -1,3 +1,7 @@
+---
+description: Options to see your udroid/termux proot Desktop Environment
+---
+
 # 🖥️ Display
 
 ### Setting up VNC
diff --git a/udroid-landing/setting-up-sound.md b/udroid-landing/setting-up-sound.md
@@ -1,3 +1,7 @@
+---
+description: setting up audio in termux proot environment
+---
+
 # 🔊 Audio
 
 pulseaudio starts every time you invoke start commands with `udroid`
diff --git a/udroid-landing/the-end.md b/udroid-landing/the-end.md
@@ -1,2 +1,9 @@
 # 💀 The End
+
 Well you've reached to end of wiki HAHAHAHAHA. Hope you enjoyed reading it and try to follow it.
+
+![](../.gitbook/assets/JustShakeItOff,ShakeItOffGIF.gif)
+
+{% hint style="success" %}
+Achivement: avarage proot user
+{% endhint %}
diff --git a/udroid-landing/tips-&-tricks.md b/udroid-landing/tips-&-tricks.md
@@ -6,3 +6,4 @@ description: >-
 
 # 👩🏻‍🔧 Tips & Tricks
 
+![](../.gitbook/assets/TipsAndTricksTutorialsGIF.gif)
diff --git a/udroid-landing/udroid/disclaimer.md b/udroid-landing/udroid/disclaimer.md
@@ -1,3 +1,7 @@
+---
+description: limits & warnings
+---
+
 # ⚠ Disclaimer
 
 **📝 Note before trying**
