Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imprakharshukla authored May 16, 2020
1 parent 4d5b4cb commit 7ad83f9
Showing 1 changed file with 95 additions and 86 deletions.
181 changes: 95 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,112 @@


<p align="center">
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/banner.png" height="715" width="805" />
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/images/app_logo_verticle.png">
</p>

&nbsp;
<p align="center">
<a href="https://forum.andronix.app"><img src="https://img.shields.io/badge/Questions%3F-Join%20our%20forum-blue?style=flat-square"></a>
<a href="https://chat.andronix.app"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-blue?style=flat-square&logo=discord"></a>
<a href="https://docs.andronix.app"><img src="https://img.shields.io/badge/Documentation-Read%20the%20docs-blue?style=flat-square"></a>
<a href="https://play.google.com/store/apps/details?id=studio.com.techriz.andronix"><img src="https://img.shields.io/badge/Download-Google%20Play-orange?style=flat-square&logo=google-play"></a>
<a href="https://github.com/AndronixApp/AndronixOrigin/releases"><img src="https://img.shields.io/badge/Download-GitHub%20Releases-orange?style=flat-square&logo=github"></a>

<br>
<h1 align="center">Install Linux on your Android 🔥</h1>
<br>

<p align="center">
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/images/app_dashboard_dark.png" width="250">
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/images/app_dashboard_light.png" width="250">
</p>

&nbsp;
# How does this work?
Andronix is simple inside the hood (well not really, but most of it is simple to understand). Andronix uses **PRoot** to run your favourite Linux distribution on your Android devices.

## AndroNix - Linux on Android

Andronix lets you install a Linux system on your Android Device without root. We found out that using Linux on Android is quite useful and lets you do many heavy tasks on your Android device.
### What exactly is PRoot?


This app lets you install various popular Linux distributions on your Android device by using Termux and PRoot functionality on the Android system. The application also provides you a graphics layer or Desktop environment (Xfce, MATE, LXDE, LXQt) on the top of the Linux shell which makes the user experience much better than working on a Linux command line.
As stated in the official website of PRoot

> AndroNix may or may not work for your device. As Linux is not optimized for Android and there can be zillion hardware combinations devices, thereby making it impossible to debug for each and every device.
> PRoot is a user-space implementation of **chroot, mount --bind, and binfmt_misc**. This means that users don't need any privileges or setup to do things like using an arbitrary directory as the new root file system, making files accessible somewhere else in the file system hierarchy, or executing programs built for another CPU architecture transparently through QEMU user-mode.
## **AndroNix 4.0 or above supports -**

* **AndroNix Premium** - We have released AndroNix Premium with tons of features.

* **Dark Mode** - Use AndroNix at night comfortably.

* **AndroNix Commands** - A special addition to the family of AndroNix. It's all you need to manage your commands throughout your life. Just copy and paste!

* **AndroNix Web App** - We have also released our web app to compliment AndroNix commands on Android, so you can now access Commands on any internet connected device.

* **AndroNix Feed** - We saw that since the last release you guys were really happy about the blogs we posted. So now we have a dedicated blog feed to make a better use of Linux and the power it offers.

* **Offline Downloads** - Internet can be unpredictable sometimes, but don't worry we're introducing offline support of Linux distros, though you'll be still needing internet to download some files depending upon your device at the time of installing.
or in easier words, the benefits of enabling PRoot include running Linux operating systems in a Termux [chroot](https://en.m.wikipedia.org/wiki/Chroot) on an Android smartphone, tablet and Chromebook.

* **7 Languages Supported** - Now you can switch between 7 native languages within the app without change the default language of your device.

* **Robust Documentation** - We've been working on writing some documentations for weeks now. This will enable you to help yourself without waiting for us to reply.

* **Priority Support** - AndroNix Premium bring priority support with it at no extra cost. IF you're an AndroNix Premium member just enjoy the blazing fast support, on the platform you like!

* **Budding Communities** - We now support official AndroNix communities on Telegram and WhatsApp. We will soon expand to other platforms as well.

* **Automation Added** - If you choose AndroNix Premium, we'll handle everything for you. Just login and forget the rest.

* **Profile Tab Added** - Profile let's you see your current status (Premium or not). If you're a premium member, profile section has many things for you.

* **Termux is now available offline** - We now offer an offline copy of Termux within
AndroNix. It is the officially signed APK with the original keys so you can update it via Google Play Store.
We use **Termux** to provide the command line and the packages that are especially compiled for Termux implemented inside Andronix.

<p align="center">
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/ubuntu.png" height="450" width="253.0" />
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/manjaro.png" height="450" width="253.0" />
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/kali.png" height="450" width="253.0"/>
</p>
# Get started now 🚀
Hey! 😊, let's introduce to the basics of the documentations around here. This is the doc-hub for Andronix, from development to installations, you can find almost everything here. [Read the documentation here](https://docsv2.andronix.app)

### Introduction Docs 📒

Here you can find all the information necessary to understand Andronix better. Diving deep in **PRoot**, **app structure** and **Shell scripts** that actually make you understand about what's actually happening.

### Installation Docs 📱
All and everything for you to get up and running with your favourite Linux Distribution. If you're seeking for help installing a distribution, this is place you need to be. [Read the installation docs](https://docsv2.andronix.app/installations/non-modded-os)

### Apps Installation 💻
Here are the installation procedures of few most popular apps like **VS Code, IntelliJ Idea, GIMP, Blender** etc. Easy to follow and quick! [Read the app installation docs](https://docsv2.andronix.app/software/browsers)

### Development Docs 👨‍💻
Looking into contributing and developing things around or for Andronix? Here you can find all the required documentation regarding **termux-packages, app, scripts** or anything to development. *We are working on it 👷‍♂️*

# What can you do with Andronix?
Pretty much anything you like to do. You're just limited by the lack of the full Linux kernel, the SELinux policies of your Android versions, your CPU architecture and your device's hardware. We have users replacing their entire laptops and computer with Andronix. We are looking for something that can support web-browsing, coding or anything else that is not really taxing on your phone's hardware then you can use Andronix without any issues.

You don't have to worry about multi-booting your system which means you can have all the Un-Modded and Modded OS installed at once. **12 OS at once given that you have the storage for it.** Install as many as you like, uninstall them when you're done.

[Here's what you can't do on Andronix systems](https://docsv2.andronix.app/)

## Is it free?

Yes! ⚡ Andronix is completely **Ad-free** and all the Un-modded distros and **free to use as much as you want**.

On the other hand [Modded OS](https://docsv2.andronix.app/installations/modded-os) are paid but they are very economical considering it is a **lifetime purchase with unlimited installs on unlimited devices.** (We spend hours optimizing and packing it, and these are very large files which we need to serve requiring a massive amount of bandwidth, which costs money).

You can also get **Andronix Premium** which is another way to support the developers. You also get a few perks including online sync with Andronix Commands and a web-app to access it from any device you want.


# What OS are supported?
Andronix currently supports 8 Un-Modded OS and 4 Modded OS at the moment.
### Un-Modded OS
1. Ubuntu
2. Debian
3. Manjaro
4. Fedora
5. Kali
6. Void
7. Alpine
8. Arch

### Desktop Environment
1. LXDE
2. LXQT
3. XFCE

### Modded OS
1. Ubuntu XFCE
2. Debian XFCE
3. Manjaro XFCE



# Are we open-source? 📖🔓


Yes but no. Andronix is partially open-source. All the free distro tar files and the shell scripts are available on our [GitHub repository](https://github.com/andronixapp). While all the paid things, like the actual Android app and all the files concerning Andronix Modded OS are close-source for obvious reasons.

That doesn't mean that we don't love open-source, **we** 💘 **open-source**. In fact if you're a developer or a maintainer of an open-source project, **we will be more than happy to provide you everything for free** for life. Just get-in touch with us and complete the process of verification😊.

<br>

# Here are a few screenshots 🤘

<br>

<p align="center">
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/audio.png" height="450" width="253.0" />
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/softwares.png" height="450" width="253.0" />
<img src="https://github.com/Techriz/AndronixOrigin/blob/master/Assets/installations.png" height="450" width="253.0"/>
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/example/example1.png" width="400" >
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/example/example2.png" width="400" >
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/example/example3.png" width="400" >
<img src="https://raw.githubusercontent.com/imprakharshukla/Readme-Resources/master/example/example4.png" width="400" >
</p>

## Some important things -

If you are new to Linux, we provide you easy and hassle-free instructions which makes your first impression of Linux a lot better. In case you still face some issues you can easily contact us on various platforms mentioned in the app. We ensure you that we will contact you as soon as possible.

Features:

- No root permissions required.
- Distros we support:
* Manjaro
* Ubuntu
* Kali Linux
* Debian
* Parrot OS
* Fedora
* Arch Linux

- Desktop environments we support:
* LXDE
* LXQT
* MATE
* XFCE

- One click install/uninstall feature.
- Features multiboot linux system.

**NOTE:**

- Termux is required.

- Android version should be atleast 5.1

- Device architecture supported: ARMv7, ARM64, x64.

## Reach us

**AndroNix communities**
Twitter- https://twitter.com/AndronixApp
Telegram- https://t.me/AndronixApp
Discord- https://discord.gg/jywhBH4

## Credits
Termux- https://play.google.com/store/apps/details?id=com.termux

0 comments on commit 7ad83f9

Please sign in to comment.