pmbootstrap-meow/docs/index.rst
Oliver Smith 1dcb68bdca
docs: add env vars page with PMB_SUDO (MR 2506)
Move the description of PMB_SUDO from the README to docs.
2024-12-03 10:08:43 +01:00

43 lines
1.3 KiB
ReStructuredText

Welcome to pmbootstrap's documentation!
=======================================
pmboostrap 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
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