Questions? #nixos-aarch64 (or #nixos) on Freenode!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Samuel Dionne-Riel de9a88a70f
Merge pull request #497 from noneucat/fix/modules-install
2 months ago
.ci .ci/instantiate-all.nix: Also lists kernels 8 months ago
.github/workflows ci: Actually run instantiate task 2 years ago
artwork artwork: Add app-background 1 year ago
bin bin/hydra-eval: Add hydra-like eval helper 1 year ago
boot boot/init: Kill splash after 10 seconds without it exiting 2 months ago
devices pine64-pinetab: remove unused crust-firmware packaging 2 months ago
doc Merge pull request #405 from samueldr-wip/feature/pkgs-pinning 12 months ago
examples stage-1: remove initFramebuffer option 2 months ago
lib lib/configuration: Allow not providing a device name 2 months ago
modules Merge pull request #412 from r-burns/asus-dumo-makeimage 2 months ago
overlay overlay/kernel-builder: use modules_install as a install target when kernel is modular 2 months ago
.gitignore gitignore: Ignore old config files 2 years ago
CONTRIBUTING.adoc doc: Add a contributing document 2 years ago
LICENSE LICENSE: update license notice 2 years ago
README.adoc README: move chat links 1 year ago
default.nix default: refer to local.nix directly 8 months ago
pkgs.nix pkgs.nix: Update pin 3 months ago
release.nix release.nix: Add kernels to the jobset 8 months ago
shell.nix shell.nix: Add android-tools 11 months ago

README.adoc

++++
<div align="center"><a href="https://mobile.nixos.org/"><img src="artwork/logo/logo.svg" alt="Mobile NixOS" title="Mobile NixOS" width="500" height="130" /></a></div>
++++

*Mobile NixOS* is a superset on top of link:https://nixos.org/nixos/[NixOS Linux],
link:https://nixos.org/nixpkgs/[Nixpkgs] and link:https://nixos.org/nix/[Nix],
aiming to abstract away the differences between _mobile_ devices.

In four words: _“NixOS, on your phone”_.

ifdef::env-github[]
Read more: <<doc/about.adoc#,About Mobile NixOS>>.
endif::[]
ifndef::env-github[]
Read more: <<about.adoc#,About Mobile NixOS>>.
endif::[]

ifdef::env-github[]
⚠<span class="escaped-code-point" data-escaped="[U+FE0F]"><span class="char">️</span></span> **Note**: Mobile NixOS is only expected to build succesfully against the **unstable** branch of Nixpkgs.
endif::[]
ifndef::env-github[]
[NOTE]
====
Mobile NixOS is only expected to build succesfully against the **unstable** branch of Nixpkgs.
====
endif::[]

== Documentation

* link:https://mobile.nixos.org/[The Mobile NixOS website] hosts the rendered link:https://github.com/NixOS/mobile-nixos/tree/master/doc[doc folder] for Mobile NixOS documentation.

As Mobile NixOS is a superset of NixOS Linux, the following documentation applies:

* link:https://nixos.org/nixos/manual[NixOS Manual] - how to install, configure, and maintain a purely-functional Linux distribution
* link:https://nixos.org/nixpkgs/manual/[Nixpkgs Manual] - contributing to Nixpkgs and using programming-language-specific Nix expressions
* link:https://nixos.org/nix/manual[Nix Package Manager Manual] - how to write Nix expressions (programs), and how to use Nix command line tools

== Community

Mobile NixOS development and questions is currently hosted on the
**NixOS on ARM** channel.

* link:https://matrix.to/#/#nixos-on-arm:nixos.org?via=nixos.org&via=matrix.org[NixOS on ARM on the NixOS Matrix Space]

The following community resources are also available, for NixOS questions.

* link:https://matrix.to/#/#nix:nixos.org?via=nixos.org&via=matrix.org[Nix and NixOS support channel on the NixOS Matrix Space]
* link:https://discourse.nixos.org/[Discourse Forum]

== Other Project Repositories

* link:https://github.com/NixOS/nix[Nix] - the purely functional package manager
* link:https://github.com/NixOS/nixpkgs[Nixpkgs] - the Nix packages collection

== Continuous Integration

Mobile NixOS is continuously built on the link:https://hydra.nixos.org/[organization's Hydra instance].

* link:https://hydra.nixos.org/jobset/mobile-nixos/unstable[Against the `nixos-unstable` branch of NixOS]
** link:https://hydra.nixos.org/job/mobile-nixos/unstable/tested[`tested` job]

There is no published artifacts for the time being, but the documentation
should point you towards resources that you can use to get started quicker when
your device is supported.

== Contributing

There are two ways your contributions can reach this project.

ifdef::env-github[]
* <<CONTRIBUTING.adoc#,Contributing to Mobile NixOS>>
endif::[]
ifndef::env-github[]
* <<contributing.adoc#,Contributing to Mobile NixOS>>
endif::[]
* link:https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md[Contributing to Nixpkgs or NixOS]

Contributions are always welcome. If it's your first time contributing:
jump in and don't be scared. Mistakes in your first contributions are room for
improvement; it is not in our nature to scold new contributors.

== License

Mobile NixOS is licensed under the link:https://github.com/NixOS/mobile-nixos/blob/master/LICENSE[MIT License].

[NOTE]
====
As with Nixpkgs, the MIT license does not apply to the packages built,
but only to the files in this repository (expressions, scripts, modules, etc.).

Patches and derivative work are covered by the licenses of their respective
packages.
====