Skip to content

Commit a2924ff

Browse files
SaicharanKandukurigitbook-bot
authored andcommitted
GitBook: [#1] added README and Disclaimer
1 parent 9d212ce commit a2924ff

File tree

10 files changed

+105
-0
lines changed

10 files changed

+105
-0
lines changed
857 KB
Loading
857 KB
Loading

.gitbook/assets/banner (1).jpg

178 KB
Loading

.gitbook/assets/four (1).png

2.52 MB
Loading

.gitbook/assets/four.png

2.52 MB
Loading

.gitbook/assets/three (1).png

1.39 MB
Loading

.gitbook/assets/three.png

1.39 MB
Loading

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# README
2+
3+
![an rendered image showing udroid ubuntu mate desktop environment running on smartphone ](<.gitbook/assets/banner (1).jpg>)
4+
5+
### Ubuntu-21.04 on android
6+
7+
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.
8+
9+
&#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)
10+
11+
codename = `udroid`
12+
13+
### Supported arch status
14+
15+
| arch | status |
16+
| ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
17+
| arm64 | ![stat](https://img.shields.io/badge/-installable-brightgreen) |
18+
| armv7l | <mark style="color:orange;"></mark>![stat](https://img.shields.io/badge/-installable-brightgreen)<mark style="color:orange;"></mark> |
19+
| armv8l | ![stat](https://img.shields.io/badge/-partially%20supported-orange) |
20+
| amd64 | ![](https://img.shields.io/badge/-inprogress-blue) |
21+
| Others | `not started` |
22+
23+
### Disclaimer
24+
25+
Just before starting the installation, you can check [this.](https://github.com/RandomCoderOrg/ubuntu-on-android/blob/beta/desclaimer.md)
26+
27+
### Installation
28+
29+
Installation, variables, sound, and other things can be found [here.](https://github.com/RandomCoderOrg/ubuntu-on-android/blob/beta/installation.md)
30+
31+
### Some Screenshot
32+
33+
![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>) ![](<.gitbook/assets/IMG\_20211014\_084106 (1).jpg>)
34+
35+
&#x20; More can be found [here.](https://github.com/RandomCoderOrg/ubuntu-on-android/blob/beta/showcase.md)
36+
37+
A small help from me if you want to build your own rootfs [wiki\_page](https://github.com/RandomCoderOrg/ubuntu-on-android/wiki/commands-took-to-make-a-custom-rootfs)
38+
39+
### Developers & credits
40+
41+
DEV #0 = [Saicharankandukuri](https://github.com/SaicharanKandukuri)
42+
43+
Dev #1 = [Gxmersam](https://github.com/GxmerSam)
44+
45+
### License
46+
47+
MIT Copyright (c) 2021 Saicharan Kandukuri
48+
49+
#### More Updates coming soon...
50+
51+
feel free to contribute to this repo.

SUMMARY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Table of contents
2+
3+
* [README](README.md)
4+
* [Disclaimer](disclaimer.md)

disclaimer.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Disclaimer
2+
3+
4+
5+
### Note & Disclaimer!
6+
7+
**A note before you try**
8+
9+
* As lot of it is preinstalled you can login and start right after you install.
10+
* Before installation, be sure that you're on stable internet and your device have 5-6gb free space for neat installation.
11+
* As this runs on termux and on software rendering so performence clearly depends on CPU, ram and storage read-write speed!
12+
* Consider not to try heavy apps unless you got a good device.
13+
* If you have any issues or suggestions make sure i know at https://github.com/RandomCoderOrg/ubuntu-on-android/issue (create an issue)
14+
15+
**Disclaimer**
16+
17+
* we don't work with any company or organization of ubuntu or any third-party sources that took in making fs(but we are welcome).
18+
* This project works by complying with SElinux android. and all aim of the project is just to run Linux on android without direct root with a twist and this project improves time by time with your support and motivation.
19+
* the Linux you trying to install from this repo is not fully functional in the target space because of the SElinux policies, and increasing requirement in Linux requirements and also because the project is set to run with `ptrace()` a low-level access in android kernel
20+
* Graphic performance is bad in vnc but a better to experience a smooth session is termux:wayland app. check this [doc](https://github.com/RandomCoderOrg/ubuntu-on-android/wiki/XWayland-in-proot)&#x20;
21+
* **(Update)** see https://github.com/RandomCoderOrg/ubuntu-on-android/wiki/XWayland-in-proot to run a smooth and fast session
22+
* This project comes without warranties or data protection
23+
* The Linux you're trying to install from this repo is not fully functional in the target space because of the SELinux policies, and increasing requirement in Linux requirements, and also because the project is set to run with ptrace() low-level access in android kernel
24+
* That lead to:
25+
* No direct access to hardware, fluctuations in services, performance overheads, sudo issues etc.
26+
27+
**Display**
28+
29+
* Access to display/control Desktop environment can be accomplished by various methods like
30+
* Termux:Wayland **Recommended**
31+
* xRDP
32+
* Vncserver ( RealVnc Viewer, Bvnc, Nethunter Vnc etc )
33+
* Xserver XSDL
34+
35+
**Audio**
36+
37+
* Audio works by enabling pulseserver with a tcp reciver module at `127.0.0.1` and `udroid` manager takes care on starting audio service ( additional setup mamy require for some apps ).
38+
39+
**HID interfaces**
40+
41+
* Keyboard and mouse emulation depends on apps you use to access desktop environment. Bvnc/nethunter KEX app provides better interface with hardware and mouse
42+
43+
**Graphics**
44+
45+
* For this time being there is no standardized way of accessing or using device GPU at its full potential so llvm pipes are used! (OpenGL version may depend on device OS). Most of the solutions are tricks to get more performence or vendor specific implementaions (like kernel graphics support layer/DRI ).
46+
* Best way to experience native Linux like performence is using Termux:Wayland app which is wayland port to android
47+
48+
**Others**
49+
50+
* PRoot for android is still in developing stage and not ready for using daily life linux. all the linux codes and apps are not devoloped for PRoot. popular apps like snap flatpack which depends on Systemd (which is not possible without root and Hallium project in android) wont work. proot on android platform is devoloping mostly by the efforts of termux and many random devolopers and a big part of linux/android user community. this projects is also result of so many experiments and a mixture of hacks and tricks to start things in android.

0 commit comments

Comments
 (0)