search

codidact / qpixel

Q&A-based community knowledge-sharing software
https://codidact.com
GNU Affero General Public License v3.0
378 stars 69 forks source link

Simplify the installation instructions. #1312

Open H4CKY54CK opened 5 months ago

H4CKY54CK commented 5 months ago

In the Arch-based section of the installation guide, the current instructions for pacman may work, but they could be improved. Namely, one should not be issuing pacman -Sy <package>, as it currently says to do. As currently written, it can lead to partial upgrades. The forced refresh at the top of the instructions is also questionable, but I can understand why it was listed.

I'm not that familiar with this project, so I can't say whether the multiple pacman commands is absolutely necessary or not. I propose two alternatives:

Install all the packages in one command, avoiding the possibility of dependency issues:

pacman -Syu gcc make ruby autoconf bison base-devel unixodbc openssl mariadb mysqld nodejs

Similarly, the Debian-based instructions could also be condensed down to a single command. Admittedly, avoiding multiple commands like this is just a preference to me, but it would simplify things.

Or, if it is necessary to install them separately and in the order they are listed, update the package database first, then use pacman -S to install what is needed:

sudo pacman -Syu
sudo pacman -S gcc
sudo pacman -S make
sudo pacman -S ruby autoconf bison base-devel unixodbc
sudo pacman -S openssl
sudo pacman -S mariadb mysqld nodejs

However, I am fairly sure this is not necessary.

I apologize if this issue is not formatted properly. This wasn't exactly a bug/feature request.

cellio commented 5 months ago

Thanks for filing this, and the formatting is just fine.