Skip to content

Commit 35b5576

Browse files
committed
Update README and quick fix
Signed-off-by: Andres Gongora <mail@andresgongora.com>
1 parent 1a55e30 commit 35b5576

File tree

3 files changed

+35
-45
lines changed

3 files changed

+35
-45
lines changed

README.md

+26-33
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![synth-shell](doc/synth-shell-status.jpg)
22

33

4-
**synth-shell-status** shows a summary of your system's current health.
4+
**synth-shell-greeter** shows a summary of your system's current health.
55
- Automatically printed in new terminal sessions (local, SSH, ...).
66
- Monitor your servers, RaspberryPis, and workstations. All system info you
77
need at a glance (e.g. external IP address, CPU temperature, etc.).
@@ -18,36 +18,33 @@
1818
# Setup
1919
<!--------------------------------------+-------------------------------------->
2020

21-
### Automatic setup
21+
22+
### Arch Linux
23+
24+
You may install `synth-shell-greeter` from AUR:
25+
https://aur.archlinux.org/packages/synth-shell-greeter-git/
26+
27+
28+
29+
### Manual setup
2230

2331
The included [setup script](setup.sh) will guide you step by step through the
24-
process and let you choose what features to install. During this setup, you can
25-
choose to install synth-shell for your user only (recommended) or system-wide
26-
(superuser privileges required). To proceed,
27-
[open and play this link in a separate tab](https://www.youtube.com/embed/MpN91wHAr1k)
28-
and enter the following into your terminal:
32+
installatioj process. Just clone this repository and run it:
2933
```
30-
git clone --recursive https://github.com/andresgongora/synth-shell.git
31-
chmod +x synth-shell/setup.sh
32-
synth-shell/setup.sh
34+
git clone --recursive https://github.com/andresgongora/synth-shell-greeter.git
35+
synth-shell-greeter/setup.sh
3336
```
3437

35-
Note that for `fancy-bash-prompt.sh` you might also need
36-
[power-line fonts](https://github.com/powerline/fonts). You can instal it
37-
as follows (the exact name of the package varies from distro to distro):
38-
39-
* ArchLinux: `sudo pacman -S powerline-fonts`
40-
* Debian/Ubuntu: `sudo apt install fonts-powerline`
38+
You can then test your script by running it from wherever you installed it.
39+
Usually this is to your user's `.config` folder, so you should run:
40+
```
41+
~/.config/synth-shell/synth-shell-greeter.sh
42+
```
4143

42-
Finally, open up a new terminal and test that everything works. Sometimes,
43-
despite power-line fonts being properly installed, the triangle separator
44-
for `fancy-bash-prompt.sh` (if installed) might still not show. In this case,
45-
make sure that your `locale` is set to UTF-8 by editing `/etc/locale.conf` file
46-
(select your language but in UTF-8 format) and running `sudo locale-gen`.
47-
[More info on locale](https://wiki.archlinux.org/index.php/locale).
48-
Alternatively, try a different font in your terminal emulator. Some fonts
49-
do not support special characters. We get the best results with
50-
[hack-ttf](https://sourcefoundry.org/hack/).
44+
If you want it to appear everytime you open a new terminal, run
45+
```
46+
echo "~/.config/synth-shell/synth-shell-greeter.sh" >> ~/.bashrc
47+
```
5148

5249

5350

@@ -61,11 +58,6 @@ folders depending on how you installed **synth-shell**:
6158

6259

6360

64-
### Uninstallation
65-
Run the setup script again (like during the installation), but choose
66-
`uninstall` when prompted.
67-
68-
6961

7062
<br/><br/>
7163

@@ -83,9 +75,10 @@ prints a user-configurable ASCII logo to impress your crush from the library
8375
with how awesome you are.
8476

8577
Feel free to customize your status report through the many available options
86-
in `~/.config/synth-shell/status.config` (user-only install) or
87-
`/etc/synth-shell/status.config` (system-wide install),or by replacing their
88-
content with the examples files you can find under the same directory.
78+
in `~/.config/synth-shell/synth-shell-greeter.config` (user-only install) or
79+
`/etc/synth-shell/synth-shell-greeter.config` (system-wide install), or by
80+
replacing their content with the examples files you can find under the same
81+
directory.
8982

9083
![status configuration options](doc/status_config_preview.png)
9184

synth-shell-greeter/info.sh

+4-7
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@
3434

3535
include(){ [ -z "$_IR" ]&&_IR="$PWD"&&cd $( dirname "$PWD/$0" )&&. "$1"&&cd "$_IR"&&unset _IR||. $1;}
3636
include 'info_print_info.sh'
37-
38-
39-
37+
include 'info_about_os.sh'
38+
include 'info_about_hardware.sh'
39+
include 'info_about_network.sh'
4040

4141

4242

4343
##==============================================================================
4444
## ONE LINERS
4545
##==============================================================================
4646

47-
include 'info_about_os.sh'
47+
4848
printInfoOS() { printInfoLine "OS" "$(getNameOS)" ; }
4949
printInfoKernel() { printInfoLine "Kernel" "$(getNameKernel)" ; }
5050
printInfoShell() { printInfoLine "Shell" "$(getNameShell)" ; }
@@ -54,11 +54,9 @@ printInfoUser() { printInfoLine "User" "$(getUserHost)" ; }
5454
printInfoNumLoggedIn() { printInfoLine "Logged in" "$(getNumberLoggedInUsers)" ; }
5555
printInfoNameLoggedIn() { printInfoLine "Logged in" "$(getNameLoggedInUsers)" ; }
5656

57-
include 'info_about_hardware.sh'
5857
printInfoCPU() { printInfoLine "CPU" "$(getNameCPU)" ; }
5958
printInfoCPULoad() { printInfoLine "Sys load" "$(getCPULoad)" ; }
6059

61-
include 'info_about_network.sh'
6260
printInfoLocalIPv4() { printInfoLine "Local IPv4" "$(getLocalIPv4)" ; }
6361
printInfoExternalIPv4() { printInfoLine "External IPv4" "$(getExternalIPv4)" ; }
6462

@@ -70,7 +68,6 @@ printInfoSpacer() { printInfoLine "" "" ; }
7068

7169

7270

73-
7471
##==============================================================================
7572
##
7673
##==============================================================================

synth-shell-greeter/synth-shell-greeter.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -349,17 +349,17 @@ printHogsMemory()
349349
##==============================================================================
350350

351351
## PRINT TOP SPACER
352-
#if $clear_before_print; then clear; fi
352+
if $clear_before_print; then clear; fi
353353
if $print_extra_new_line_top; then echo ""; fi
354354

355355

356356

357357
## PRINT GREETER ELEMENTS
358358
printHeader
359-
#printLastLogins
360-
#printSystemctl
361-
#printHogsCPU
362-
#printHogsMemory
359+
printLastLogins
360+
printSystemctl
361+
printHogsCPU
362+
printHogsMemory
363363

364364

365365

0 commit comments

Comments
 (0)