Skip to content

Commit

Permalink
Delete installation script
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoplaitano committed Jan 5, 2024
1 parent d31463d commit 228305d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 105 deletions.
93 changes: 28 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# evemenu

This script lets the user interact with a non-intrusive menu based on [dmenu].
This script lets you interact with a custom *actions menu* based on [dmenu].

The idea is to expand on the basic functionality of **dmenu** by defining
personal commands, applications, routines and other scripts to run with it.
Expand All @@ -11,82 +11,61 @@ personal commands, applications, routines and other scripts to run with it.

## Installation

**Note:** It only works on <u>Ubuntu</u> or <u>Arch</u> based distributions,
since it uses either `apt` or `pacman` to install.
This project consists of a single bash script.
To "install" it, copy it to the `bin` directory and give it executable
permissions.

```shell
git clone https://github.com/marcoplaitano/evemenu
cd evemenu && ./install.sh
```sh
git clone https://github.com/marcoplaitano/evemenu && cd evemenu
sudo cp evemenu /usr/local/bin/evemenu
sudo chmod 755 /usr/local/bin/evemenu
```

The `install.sh` script clones and installs [my own patched version] of
**dmenu** with all its dependencies.

**Note:** `evemenu` will be in `$HOME/.local/bin`; make sure this is in `$PATH`.
**Note**: it relies on the **dmenu** utility; you can install it from
[this repository].

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

## Usage

After the installation, you can launch the program with the following command:

```shell
evemenu
```

**Tip:** assign the execution of the program to a keyboard shortcut (like
`Alt+Space` ) to speed up your workflow.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

## Configuration

The script takes no command line arguments; all the options have to be manually
edited in the file itself.
Launch the script with the `evemenu` command.

### Appearance

You can customize the appearance of dmenu.
The program accepts custom values for the font and the colors of normal/selected
items.
You can customize the appearance with custom values for the font, the
background and foreground colors.
These are defined as variables in the script itself.

### Actions

The most important part of the script is the dictionary containing all the
actions that can be executed.
The values are the routines to run and the keys are the names the user has to
type to execute the commands.
The **values** are the routines to run and the **keys** are the names the user
has to type to execute the commands.

```sh
# [key]=value
declare -A actions=(
[github]="firefox --new-instance https://www.github.com"
[nightmode]="night_mode.sh --now"
[chatgpt]="firefox https://chat.openai.com/"
[nightmode]="night_mode.sh --on"
[spotify]="spotify"
)
```

With this example the user only has to launch the script and type out either
`github`, `nightmode` or `spotify` and the correspondent action will be
With this example, launch the script and type out (or select with the arrows)
either *chatgpt*, *nightmode* or *spotify* and the correspondent action will be
performed.

The advantage of a script like this, compared to **rofi** or **dmenu** itself
is the idea of having custom actions which can both be applications (like
`spotify`) or more complex commands with arguments and options (`github`), or
even other scripts (`nightmode`).
The advantage of **evemenu**, compared to the standard **dmenu** utility,
is the possibility of defining custom actions which can be applications (like
`spotify`) or more complex commands with arguments and options (like `chatgpt`,
opening a specific link in the browser), or even other scripts (`nightmode`).

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

## Dependencies

The only dependency is dmenu. It is installed via this [script].

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

## Contributing

You can contribute by:
+ proposing a better name than **evemenu**
+ making [this] installation process available for other platforms too.
The only dependency is the **dmenu** utility. Install it from [this repository].

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Expand All @@ -106,29 +85,13 @@ Distributed under the [MIT] license.
https://tools.suckless.org/dmenu/
"dmenu website"

[configurable]:
#actions
"Link to header"

[demo gif]:
https://github.com/marcoplaitano/images/blob/main/evemenu_demo.gif
"Demo GIF"

[download]:
https://github.com/marcoplaitano/evemenu/archive/refs/heads/master.zip
"Zip download"

[my own patched version]:
[this repository]:
https://github.com/marcoplaitano/dmenu
"My fork of dmenu"

[script]:
https://github.com/marcoplaitano/dmenu/tree/main/install.sh
"dmenu installation script"

[this]:
https://github.com/marcoplaitano/dmenu/tree/main/install.sh
"dmenu installation script"
"Github repository"

[MIT]:
LICENSE
Expand Down
40 changes: 0 additions & 40 deletions install.sh

This file was deleted.

0 comments on commit 228305d

Please sign in to comment.