Skip to content

Commit a21e037

Browse files
committed
UPDATED: Changing README.md and help to adapt to new release
1 parent 744ff29 commit a21e037

File tree

2 files changed

+32
-31
lines changed

2 files changed

+32
-31
lines changed

README.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ Customizer is a software to automatize installations and customizations in a Lin
2020
installed. Enjoy! 🤖
2121

2222

23-
## ⌨️ Description
24-
These `bash` scripts can automatize the installation and uninstallation of a batch of preset
23+
## ⌨️ Description
24+
25+
These `bash` scripts can automate the installation and uninstallation of a batch of preset
2526
features in most Linux environments. These features include GNU software, programming languages,
2627
IDEs, text editors, media players, games, Internet applications, file templates, wallpapers,
27-
environment aliases, environment functions, terminal personalization...
28+
environment aliases, environment functions and terminal personalization.
2829

2930
All installations are cleaner, faster and fancier than a manual installation,
3031
and of course all installations are **completely unattended**.
@@ -63,60 +64,60 @@ path. This will be the expected situation in the following explanations.
6364

6465
You can also install the customizer by using:
6566
```
66-
sudo bash install.sh customizer
67+
sudo bash src/core/install.sh customizer
6768
```
6869
This will give you the global command `customizer-install` that you can use anywhere in your system to access the
69-
features in `install.sh`. This command has autocompletion features.
70+
features in `install.sh` script. This command has autocompletion features.
7071

7172

7273
## 🚀 Usage
73-
The scripts `install.sh` and `uninstall.sh` have the same identical arguments, but behave in
74+
The commands `customizer-install` and `customizer-uninstall` have the same identical arguments, but behave in
7475
the opposite way:
75-
`install.sh` will install the features selected by the arguments while `uninstall.sh` will
76+
`customizer-install` will install the features selected by the arguments while `customizer-uninstall` will
7677
uninstall them, using the same identical arguments. They also share their vast majority of behavioural arguments,
7778
used to modify the way in which one or more features are installed.
7879

79-
See [`FEATURES.md`](https://github.com/AleixMT/Linux-Auto-Customizer/blob/master/FEATURES.md) to see a full list of all
80+
See [`FEATURES.md`](https://github.com/AleixMT/Linux-Auto-Customizer/blob/master/doc/FEATURES.md) to see a full list of all
8081
the already pre-coded features in customizer ready to install / uninstall. You can also issue the command to show the
8182
full help, which contains a table with all the available arguments and its corresponding features.
8283
```
83-
bash install.sh -H
84+
customizer-install -H
8485
```
8586

8687

8788
#### ⚙️ Feature arguments
8889
You can install or uninstall features easily by passing the feature keynames by argument:
8990
```
90-
bash install.sh discord
91-
bash uninstall.sh discord
91+
customizer-install discord
92+
customizer-uninstall discord
9293
```
9394
You can install or uninstall multiple features at once:
9495
```
95-
bash install.sh pycharm intellij wallpapers
96-
bash uninstall.sh pycharm intellij wallpapers
96+
customizer-install pycharm intellij wallpapers
97+
customizer-uninstall pycharm intellij wallpapers
9798
```
9899
You will need to use `sudo` to install or uninstall some features, since elevated privileges are required:
99100
```
100-
sudo bash install.sh skype steam parallel lolcat dia
101-
sudo bash uninstall.sh skype steam parallel lolcat dia
101+
sudo customizer-install skype steam parallel lolcat dia
102+
sudo customizer-uninstall skype steam parallel lolcat dia
102103
```
103104
Features that do not require elevated privileges can also be installed or uninstalled with elevated privileges:
104105
```
105-
bash install.sh pycharmpro intellijultimate
106-
bash uninstall.sh pycharmpro intellijultimate
106+
customizer-install pycharmpro intellijultimate
107+
customizer-uninstall pycharmpro intellijultimate
107108
```
108109

109110

110111
#### ⚙️ Wrapper arguments (for selecting multiple features)
111112
There are some special arguments called wrappers that select the installation / uninstallation of a set of features:
112113
```
113-
bash install.sh gitbashfunctions bashfunctions
114-
bash uninstall.sh gitbashfunctions bashfunctions
114+
customizer-install gitbashfunctions bashfunctions
115+
customizer-uninstall gitbashfunctions bashfunctions
115116
```
116117
This is equivalent to:
117118
```
118-
bash install.sh pull push dummycommit commit checkout clone branch status add hard fetch a b c e f h j k L l o q s u x
119-
bash uninstall.sh pull push dummycommit commit checkout clone branch status add hard fetch a b c e f h j k L l o q s u x
119+
customizer-install pull push dummycommit commit checkout clone branch status add hard fetch a b c e f h j k L l o q s u x
120+
customizer-uninstall pull push dummycommit commit checkout clone branch status add hard fetch a b c e f h j k L l o q s u x
120121
```
121122

122123

@@ -127,46 +128,46 @@ tolerance, checking if the installation is already present.
127128
###### Verbosity
128129
Installs Telegram showing all the output from the internal commands:
129130
```
130-
bash install.sh -v telegram
131+
customizer-install-v telegram
131132
```
132133
Installs firefox and gpaint without showing any output.
133134
```
134-
sudo bash install.sh -q firefox gpaint
135+
sudo customizer-install -q firefox gpaint
135136
```
136137
Each behaviour is maintained until the end of the execution or until it is changed by another behavioural argument.
137138
In this case the program cheese and the program dia are installed without showing any output, but spotify is on full
138139
verbose mode.
139140
```
140-
sudo bash install.sh -q cheese dia -v spotify
141+
sudo customizer-install -q cheese dia -v spotify
141142
```
142143

143144
#### 🔧 Full installation / uninstallation
144145
To install ALL the features available for the root user in the script you must type in a terminal:
145146
```
146-
sudo bash install.sh --root
147+
sudo customizer-install --root
147148
```
148149
To install ALL the features available for the normal user in the script you must type in a terminal:
149150
```
150-
bash install.sh --user
151+
bash customizer-install --user
151152
```
152153
📄 Summarizing: to install ALL the features available in the script you must type in a terminal:
153154
```
154-
sudo bash install.sh --root && bash install.sh --user
155+
sudo customizer-install --root && bash install.sh --user
155156
```
156157
This command will install all root features first while asking for elevated privileges,
157158
and then it will install all the local user features.
158159

159160
To uninstall ALL the features available for the root user in the script you must type in a terminal:
160161
```
161-
sudo bash uninstall.sh --root
162+
sudo customizer-uninstall --root
162163
```
163164
To uninstall ALL the features available for the normal user in the script you must type in a terminal:
164165
```
165-
bash uninstall.sh --user
166+
customizer-uninstall --user
166167
```
167168
📄 Summarizing: to uninstall ALL the features available in the script you must type in a terminal:
168169
```
169-
sudo bash uninstall.sh --root && bash uninstall.sh --user
170+
sudo customizer-uninstall --root && customizer-uninstall --user
170171
```
171172
This command will uninstall all root features first while asking for elevated privileges,
172173
and then it will uninstall all the local user features.

data/core/common_data.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ declare -r auxiliary_arguments=("-v" "-q" "-Q" "-s" "-o" "-e" "-i" "-d" "-c" "-C
707707
declare -r wrapper_programmingcore=("python3" "gcc" "jdk11" "git" "GNU_parallel")
708708
declare -r wrapper_programmingide=("android_studio" "sublime_text" "pycharm" "intellij_community" "visualstudiocode" "pypy3" "clion")
709709
declare -r wrapper_programmingpro=("intellij_ultimate" "pycharm_professional" "clion")
710-
declare -r wrapper_texteditorcore=("atom" "openoffice" "latex" "geany" "notepadqq" "gvim")
710+
declare -r wrapper_texteditorcore=("openoffice" "latex" "geany" "notepadqq" "gvim")
711711
declare -r wrapper_mediacore=("vlc" "gpaint" "okular" "clementine")
712712
declare -r wrapper_systemcore=("virtualbox" "gparted" "clonezilla")
713713
declare -r wrapper_internetcore=("transmission" "thunderbird" "f-irc" "telegram" "dropbox" "discord" "megasync" "google_chrome" "firefox" "cheat")

0 commit comments

Comments
 (0)