1
1
mirror of https://github.com/NixOS/mobile-nixos.git synced 2024-12-17 04:51:31 +03:00
not really known
Go to file
Samuel Dionne-Riel 32f58ada71
Merge pull request #262 from samueldr-wip/feature/stage-0
stage-0: Add ability to boot in generation kernel+initrd
2020-12-29 18:13:24 -05:00
.ci ci: Add assertion that validates evaluations are differents 2020-04-07 23:12:18 -04:00
.github/workflows ci: Update dependencies 2020-11-22 16:17:23 -05:00
artwork boot/error: Rework UI for better reporting 2020-11-13 19:46:44 -05:00
bin bin/menuconfig: hardcode program name 2020-10-09 20:26:03 -04:00
boot boot/init: switch_root keeps selected generation in stage-0 2020-12-29 17:59:09 -05:00
devices Merge pull request #262 from samueldr-wip/feature/stage-0 2020-12-29 18:13:24 -05:00
doc doc: List stage-0 support on the device page 2020-12-27 17:50:30 -05:00
examples examples/demo: Add file 2020-12-27 17:38:29 -05:00
lib image-builder: build GPT using cgpt 2020-10-15 19:15:46 -04:00
modules Merge pull request #262 from samueldr-wip/feature/stage-0 2020-12-29 18:13:24 -05:00
overlay ufdt-apply-overlay: Init at 2020-12-13 2020-12-27 17:31:08 -05:00
profiles Adds an installer output... 2019-09-21 22:45:41 -04:00
.gitignore gitignore: Ignore old config files 2020-09-29 20:15:53 -04:00
CONTRIBUTING.adoc doc: Add a contributing document 2020-04-29 18:02:34 -04:00
default.nix Allow evaluating a device from a path 2020-07-28 00:05:14 -04:00
LICENSE LICENSE: update license notice 2020-05-04 19:28:41 -04:00
README.adoc README: Add note about unstable branch 2020-06-17 16:03:28 -04:00
release.nix release.nix: pre-built demo rootfs is generic 2020-12-27 17:38:29 -05:00
shell.nix shell.nix: Add autoport 2020-10-02 22:50:36 -04:00

++++
<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[]
⚠️ **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 AArch64
channel for NixOS.

 * link:irc://irc.freenode.net/#nixos-aarch64[IRC - #nixos-aarch64 on freenode.net]

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

 * link:irc://irc.freenode.net/#nixos[IRC - #nixos on freenode.net]
 * 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.
====