1
0
Fork 1
mirror of https://gitlab.postmarketos.org/postmarketOS/pmbootstrap.git synced 2025-07-12 19:09:56 +03:00
pmbootstrap/docs/index.rst
Oliver Smith 7510e80b7b
docs/cross_compiling: new page (MR 2562)
Add the cross compiling documentation to the pmbootstrap docs.

This is based on the following wiki pages, but updated to reflect new
changes with cross-native2 and to make it more readable:
* https://wiki.postmarketos.org/wiki/Pmbootstrap/Cross_Compiling
* https://wiki.postmarketos.org/wiki/Build_internals#Cross-compile_types

Co-authored-by: Caleb Connolly <caleb@postmarketos.org>
2025-03-02 17:07:41 +01:00

44 lines
1.3 KiB
ReStructuredText

Welcome to pmbootstrap's documentation!
=======================================
pmbootstrap is the central command-line application for postmarketOS development. Among other things,
it allows building packages, creating installation images and flashing themx to your device. If you just want to install
postmarketOS, read the `Installation`_ wiki article first since you might not need pmbootstrap depeing on the method.
For the latest releases please check the `repository`_.
In case of any problems that is also the place to check the `issue-tracker`_.
For further information, please check out the `postmarketOS-wiki`_.
.. toctree::
:maxdepth: 3
:caption: Contents:
installation
usage
chroot
debugging
cross_compiling
ssh-keys
api/modules
mirrors
environment_variables
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
*Note:* This documentation is currently a work-in-progress, your feedback and contributions are very welcome!
.. _postmarketOS-wiki: https://wiki.postmarketos.org/wiki/Main_Page
.. _issue-tracker: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/-/issues
.. _repository: https://gitlab.postmarketos.org/postmarketOS/pmbootstrap/
.. _Installation: https://wiki.postmarketos.org/wiki/Installation