Skip to content

Commit

Permalink
Updating README, INSTALLATION and SETUP
Browse files Browse the repository at this point in the history
  • Loading branch information
jzbor committed Nov 7, 2023
1 parent e3704fd commit 4e01908
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
22 changes: 10 additions & 12 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Installation

## NetBSD ([Official repositories](https://pkgsrc.se/wm/marswm/))
## Archlinux ([AUR](https://aur.archlinux.org/packages/marswm))
```sh
paru -S marswm
# or
yay -S marswm
```

[`marswm-git`](https://aur.archlinux.org/packages/marswm) is also available as the development version.


## NetBSD ([Official repositories](https://pkgsrc.se/wm/marswm/))
```sh
pkgin install marswm
```
Expand All @@ -14,24 +23,13 @@ make install
```


## Archlinux ([AUR](https://aur.archlinux.org/packages/marswm-git))

```sh
paru -S marswm-git
# or
yay -S marswm-git
```


## Nix

`marswm` is currently not officially packaged for Nix.
You can use the derivation in [`examples/default.nix`](./examples/default.nix) to install it on your machine.
Make sure to update the version number and hash accordingly.


## Other ([cargo](https://crates.io/crates/marswm))

This guide shows installation for a standard Linux distribution that supports the Standard File Hierarchy.

For non-standard distributions (e.g. `doas` instead of `sudo`, no FHS-support) you will have to change some things.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Although not currently planned a wayland backend (as well as other backends) wou
## Installation (with package manager)
See [INSTALLATION.md](./INSTALLATION.md).

For a guide on how to setup a working desktop environment with marswm as base take a look at [SETUP.md](./SETUP.md).


## Building from Source
You have to install the following libraries natively: `libX11`, `libXft`, `libXinerama`, `libXrandr`.
Expand Down
2 changes: 1 addition & 1 deletion SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Make sure to restart the WM for the bindings to take effect.
After installing the script you can generate the icon cache it by running `xdg-xmenu -f`.
Now you should be able to access the menu when right-clicking the desktop.

### Rofi /dmenu
### Rofi / dmenu
You will probably also want a keyboard-driven option to access your applications.
By default `marswm` comes with keybindings for [`Rofi`](https://github.com/davatorium/rofi) preconfigured.
Make sure to install and customize it to your liking, then you should be able to run it by pressing `MOD + d`.
Expand Down

0 comments on commit 4e01908

Please sign in to comment.