Merge pull request #1 from kevadesu/main

Adding documentation

Author: MTSyntho

README.md

@@ -0,0 +1,54 @@
+# AzuOS
+
+## What is AzuOS?
+AzuOS is an Arch-based operating system, that features its own desktop made on top of Openbox.
+
+## What is this repository for?
+This repository hosts the archiso configuration and files for building an AzuOS system.
+
+## Build instructions
+
+### Prerequisites
+To build the archiso-config, you need to have a system running **Arch Linux** (or derivatives).
+
+The following packages are ALSO required for building:
+- git
+- xorriso
+- arch-install-scripts
+- dosfstools
+- erofs-utils
+- libburn
+- libisoburn
+- libisofs
+- mtools
+- squashfs-tools
+- archiso
+
+You can install these by running the following command with administrative permissions:
+
+```bash
+pacman -S git xorriso arch-install-scripts dosfstools erofs-utils libburn libisoburn libisofs mtools squashfs-tools archiso
+```
+
+### Cloning repository
+Next, clone this repository by running the following in the Arch system:
+
+```bash
+git clone https://github.com/AzuSystem/archiso
+```
+
+### Build system
+Change directory into the newly cloned repository, make an "out" directory in it and start building the config (with administrative permissions again):
+
+```bash
+cd archiso; mkdir out; mkarchiso -v -w /tmp/archiso-tmp -o ./out ./
+```
+
+In a more understandable format:
+```bash
+cd archiso
+mkdir out
+mkarchiso -v -w /tmp/archiso-tmp -o /path/to/cloned-repo/out /path/to/cloned-repo/
+```
+
+The output image should then be inside of the "out" directory.

packages.x86_64

@@ -1,3 +1,4 @@
+
 alsa-utils
 amd-ucode
 arch-install-scripts
@@ -15,6 +16,7 @@ cloud-init
 cryptsetup
 darkhttpd
 ddrescue
+default-cursors
 dhclient
 diffutils
 dmidecode
@@ -29,26 +31,38 @@ ethtool
 exfatprogs
 f2fs-tools
 fatresize
+feh
+firefox
 foot-terminfo
 fsarchiver
+git
 gpart
 gpm
 gptfdisk
 grml-zsh-config
 grub
 hdparm
+hyfetch
 hyperv
+intel-media-driver
 intel-ucode
+inter-font
 irssi
 iw
 iwd
 jfsutils
+kitty
 kitty-terminfo
 ldns
 less
 lftp
 libfido2
 libusb-compat
+libva-intel-driver
+libva-mesa-driver
+libxcb
+libxcursor
+libxrandr
 linux
 linux-atm
 linux-firmware
@@ -63,6 +77,7 @@ mc
 mdadm
 memtest86+
 memtest86+-efi
+mesa
 mkinitcpio
 mkinitcpio-archiso
 mkinitcpio-nfs-utils
@@ -71,25 +86,39 @@ mtools
 nano
 nbd
 ndisc6
+neofetch
+network-manager-applet
+networkmanager
 nfs-utils
 nilfs-utils
 nmap
 ntfs-3g
 nvme-cli
 open-iscsi
 open-vm-tools
+openbox
 openconnect
 openpgp-card-tools
 openssh
 openvpn
+papirus-icon-theme
 partclone
 parted
 partimage
 pcsclite
+picom
+plymouth
 ppp
 pptpclient
 pv
+python
+python-pip
+python-pyqt5
+python-pyqt5-webengine
+python-pywebview
+python-qtpy
 qemu-guest-agent
+qt5
 refind
 reflector
 rp-pppoe
@@ -108,6 +137,7 @@ systemd-resolvconf
 tcpdump
 terminus-font
 testdisk
+tk
 tmux
 tpm2-tools
 tpm2-tss
@@ -118,55 +148,26 @@ usbutils
 vim
 virtualbox-guest-utils-nox
 vpnc
-wireless-regdb
+vulkan-intel
+vulkan-radeon
 wireless_tools
+wireless-regdb
 wpa_supplicant
 wvdial
-xfsprogs
-xl2tpd
-zsh
-networkmanager
-network-manager-applet
-python
-python-pip
-python-pywebview
-git
-xorg
-xorg-xinit
-qt5
-python-qtpy
-python-pyqt5
-python-pyqt5-webengine
-intel-media-driver
-libva-intel-driver
-libva-mesa-driver
-vulkan-intel
-vulkan-radeon
-xf86-video-amdgpu
-xf86-video-ati
-xf86-video-nouveau
-xf86-video-vmware
-mesa
-plymouth
-libxcb
 xcb-proto
 xcb-util
 xcb-util-image
 xcb-util-keysyms
 xcb-util-renderutil
 xcb-util-wm
 xdg-utils
-default-cursors
-libxcursor
-libxrandr
+xf86-video-amdgpu
+xf86-video-ati
+xf86-video-nouveau
+xf86-video-vmware
+xfsprogs
+xl2tpd
+xorg
+xorg-xinit
 xorg-xrandr
-openbox
-feh
-kitty
-inter-font
-tk
-papirus-icon-theme
-picom
-firefox
-neofetch
-hyfetch
+zsh