@@ -79,6 +79,40 @@ optional packages you found and filtered.
7979 - Commands:
8080 - ` optional-packages -s no -p lsd kitty -s yes -e python gtk3 -p virtualbox -e perl -i no -i yes bat xterm `
8181
82+ ## INSTALLATION AND MANUAL EXECUTION
83+
84+ ### Installation
85+
86+ #### Introduction
87+
88+ This package is stored in the AUR (Arch Linux User Repository). AUR is a repository where anyone with an Arch Linux web
89+ account can upload a configuration file, which has instructions for downloading and installing the package. In addition,
90+ it contains information on the people who maintain or contribute to it.
91+
92+ #### AUR package installer
93+
94+ Normally, the ` pacman ` command is used to install official packages. However, this command does not work for AUR
95+ packages. There are specific tools that help AUR package management, like ` yay ` .
96+
97+ To install this package, first [ install yay] [ install yay ] and then run the following
98+ command: ` yay --sync optional-packages ` .
99+
100+ ### Manual execution
101+
102+ [ Directly download] [ raw file of this package ] the [ optional-packages] [ this package file ] file and use it on your
103+ computer.
104+
105+ Verify that the file has the appropriate execution permissions for your needs: ` ls --long optional-packages ` . You can
106+ add execute permissions to the owner user with ` chmod u+x optional-packages ` or to all
107+ with ` chmod +x optional-packages ` .
108+
109+ Run this tool with one of the following commands.
110+
111+ - ` ./optional-packages --help ` .
112+ - ` bash optional-packages --help ` .
113+ - ` /usr/bin/env bash optional-packages --help ` .
114+ - ` /usr/bin/bash optional-packages --help ` .
115+
82116## CONTRIBUTE
83117
84118You can always follow the official GitHub guides: [ contributing to projects] [ contributing to projects ]
@@ -134,7 +168,7 @@ Use the version format vX.X.X, where X equals to numbers, for example: v45.7.211
134168
135169### Change in the source code.
136170
137- - Manually change the version in [ ./src/optional-packages] [ package file in GitHub ] . Find the variable ` VERSION="vX.X.X" `
171+ - Manually change the version in [ ./src/optional-packages] [ this package file] . Find the variable ` VERSION="vX.X.X" `
138172 in the first few lines and change it to the new version.
139173- Check if the variable ` ENV_IS_PRODUCTION ` has the ` true ` value
140174 in [ .github/workflows/deploy-to-aur.yml] [ deploy workflow in GitHub ] file.
@@ -174,24 +208,28 @@ Use the version format vX.X.X, where X equals to numbers, for example: v45.7.211
174208
175209Review the complete [ To-Do list] [ ToDo ] to review what is pending.
176210
177- [ new release url ] : https://github.com/airvzxf/archlinux-optional-packages/releases/new
178-
179- [ package file in GitHub ] : ./src/optional-packages
211+ [ AUR repository ] : https://aur.archlinux.org/cgit/aur.git/?h=optional-packages
180212
181- [ deploy workflow in GitHub ] : .github/workflows/deploy-to- aur.yml
213+ [ AUR webpage package ] : https:// aur.archlinux.org/packages/optional-packages
182214
183215[ CI deploy to AUR ] : https://github.com/airvzxf/archlinux-optional-packages/actions/workflows/deploy-to-aur.yml
184216
185- [ AUR repository ] : https://aur.archlinux.org/cgit/aur.git/?h=optional-packages
186-
187- [ AUR webpage package ] : https://aur.archlinux.org/packages/optional-packages
217+ [ ToDo ] : ./TODO.md
188218
189219[ contributing to projects ] : https://docs.github.com/en/get-started/quickstart/contributing-to-projects
190220
221+ [ deploy workflow in GitHub ] : .github/workflows/deploy-to-aur.yml
222+
191223[ fork a repository ] : https://docs.github.com/en/get-started/quickstart/contributing-to-projects#creating-a-branch-to-work-on
192224
225+ [ fork optional packages project ] : https://github.com/airvzxf/archlinux-optional-packages/fork
226+
227+ [ install yay ] : https://github.com/Jguer/yay#installation
228+
229+ [ new release url ] : https://github.com/airvzxf/archlinux-optional-packages/releases/new
230+
193231[ optional packages GitHub project ] : https://github.com/airvzxf/archlinux-optional-packages
194232
195- [ fork optional packages project ] : https://github. com/airvzxf/archlinux-optional-packages/fork
233+ [ raw file of this package ] : https://raw.githubusercontent. com/airvzxf/archlinux-optional-packages/main/src/optional-packages
196234
197- [ ToDo ] : ./TODO.md
235+ [ this package file ] : ./src/optional-packages
0 commit comments