1
1
mirror of https://github.com/NixOS/mobile-nixos.git synced 2024-09-11 03:55:23 +03:00

README.md -> README.adoc

This commit is contained in:
Samuel Dionne-Riel 2019-11-11 16:46:05 -05:00
parent d1a088ad14
commit e7c657cfc2
2 changed files with 12 additions and 16 deletions

View File

@ -1,11 +1,9 @@
Mobile NixOS
============
= Mobile NixOS
*This is expected to be built against the nixos-unstable for now.*
2-minutes startup
-----------------
== 2-minutes startup
For an already bootloader-unlocked Android-based, `fastboot`-using device.
@ -20,7 +18,7 @@ adb wait-for-device && adb reboot bootloader
fastboot boot result
```
### Booting qemu
=== Booting qemu
The qemu target has a `vm` build output, which results in a script that will
automatically start the "virtual device".
@ -33,7 +31,7 @@ nix-build --argstr device qemu-x86_64 -A build.vm
./result
```
### `local.nix`
=== `local.nix`
This file is used to work on producing build artifacts from the "WIP" repository
checkout. This is equivalent to adding settings in `configuration.nix`.
@ -60,8 +58,7 @@ This is the current mechanism expected to be used to create special builds using
the mobile-nixos tooling (e.g. to create a custom special `boot.img`).
Goals
-----
== Goals
The goal is to get a NixOS system running on mobile devices, e.g. Android phones.
@ -73,9 +70,8 @@ other way around, it increases the odds that people will start using the project
and contribute back.
Prior work
----------
== Prior work
This project initially borrowed and relied on the hard work from the
[PostmarketOS project](https://postmarketos.org/). They are forever
link:https://postmarketos.org/[PostmarketOS project]. They are forever
thanked in their efforts.

View File

@ -26,15 +26,15 @@ stdenv.mkDerivation {
rm -f README.md
# Replace it in-place with the repo README.
cat >> README.md <<EOF
README.md
=========
cat >> README.adoc <<EOF
README.adoc
===========
include::_support/common.inc[]
:relative_file_path: README.md
:relative_file_path: README.adoc
EOF
tail -n +3 ${../README.md} >> README.md
tail -n +3 ${../README.adoc} >> README.adoc
# Copies the generated asciidoc source for the devices.
cp -prf ${devices}/devices devices