docs: 📝 provide quick installation instructions

fix: 📝 provide more feedback after installation
This commit is contained in:
Mikhail Zolotukhin 2021-10-03 01:25:11 +03:00
parent 2acc271174
commit cf59968dca
3 changed files with 15 additions and 10 deletions

View File

@ -44,19 +44,21 @@ Project goals are the following:
## 🔧 Installation
## Simple
### Simple and Quick
Go to [releases](https://github.com/gikari/bismuth/releases), download the
Paste the following script in the command line:
wget -q -O - https://git.io/J2gLk | sh
This will download the latest release and execute the installation script.
### Manual
Alternatively, go to [releases](https://github.com/gikari/bismuth/releases), download the
latest `bismuth.tar.gz` archive, unzip it and execute the installation script,
that is inside.
<!-- Paste the following script in the command line: -->
<!-- cd /tmp; wget https://git.io/J2lG0; tar xf bismuth.tar.gz; cd -; cd /tmp/bismuth; ./install.sh; cd - -->
<!-- This will download the latest release and execute an installation script. -->
## From source
### From Source
Install script from source:

View File

@ -7,7 +7,7 @@
set -e
# Download latest release
echo "🕸️ Downloading the latest release..."
echo "🕸️ Downloading the latest Bismuth release..."
wget -q --output-document /tmp/bismuth.tar.gz https://github.com/gikari/bismuth/releases/latest/download/bismuth.tar.gz
# Extract it

View File

@ -24,3 +24,6 @@ echo "🔧 Enabling user configuration..."
mkdir -p ~/.local/share/kservices5/
ln -sf ~/.local/share/kwin/scripts/bismuth/metadata.desktop ~/.local/share/kservices5/bismuth.desktop
echo "🎉 Installation finished."
echo "💡 You can enable and configure Bismuth in the System Settings > Window Management > KWin Scripts."
echo "🦾 Enjoy your tiling!"