ARU mirror from GitHub

Vasiliy Stelmachenok 722752e5b4 Update donation link 4 days ago
archive 1384b76743 Upload archive from google docs 2 years ago
docs 722752e5b4 Update donation link 4 days ago
.gitignore b60a6e6275 sphinx: Fix CI building 2 years ago
.woodpecker.yml 5e1ad792fc ci: Add missing dependency for PDF step 4 months ago
LICENSE 3b51742a10 Change LICENSE 2 years ago
README.md c1428da61f readme: Add @Terromur to credits 10 months ago
README.ru.md c1428da61f readme: Add @Terromur to credits 10 months ago

README.md

ARU

English - Русский

This is an assistant to set up your Arch Linux system in order to get the best possible performance and set up your system for a comfortable gaming experience. Here you can also find guides to optimize your DE (Desktop Environment): GNOME/KDE/Cinnamon and a bit for Xfce. This project is not meant to replace the Arch Wiki, it's only a practical guide written based on the personal experience of the authors.

This repository mirrors and is now the main repository of the Google Docs manual of the same name.

About the two repositories

The project was originally hosted on GitHub, but at some point it moved to Codeberg and is still developing there. Nevertheless, the repository on GitHub didn't disappear and is essentially just a mirror for Codeberg. If you want to contribute to project, it's best to submit changes to the Codeberg repository. The domain https://ventureoo.github.io/ARU is saved and redirects you to the actual address.

Contents

Acknowledgements

The main contributions to the project were made by these people:

Many thanks to these people for their pointing out errors:

How can I contribute to the project?

The project is not in its most active phase at the moment, but I'm still willing to accept any edits to improve the written material or adding new sections. Please, if you would like to contribute.

At the beginning:

1) Open a issue in our Codeberg repository (https://codeberg.org/ventureo/ARU, registration required) 2) Or create a Pull Request and submit it to our Codeberg/GitHub repository.

If you choose the second option, you will need to know how to work with files in the ReStructuredText (ReST) format. This is whereall the sections you can find in docs/source/. I recommend that you study the following materials before you start making your edits:

https://docutils.sourceforge.io/docs/user/rst/quickref.html

https://www.sphinx-doc.org/en/master/usage/index.html

The easiest way to get your edits in the ARU, for "dummies" in Git, so to speak, is to use the web interface on GitHub or Codeberg to edit it. There you can also you can check your changes to make sure they are correct and true.

Only after the author has reviewed and merged your edits will they be available in the web ARU version (https://ventureo.codeberg.page/).