Skip to content

Commit

Permalink
chore(readme): add display settings issue
Browse files Browse the repository at this point in the history
  • Loading branch information
jthomaschewski committed Apr 2, 2023
1 parent 47123fa commit e720fd3
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,43 @@
# i3-cinnamon [![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/) [![Maintenance](https://img.shields.io/maintenance/yes/2022.svg)]()
# i3-cinnamon [![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/) [![Maintenance](https://img.shields.io/maintenance/yes/2023.svg)]()

Allows you to use i3-wm with Cinnamon Session infrastructure.

# What to expect from this?
With `i3-cinnamon` you get along with i3 (Window Manager) and GNOME (Desktop Environment) instead of metacity (the default window manager of GNOME).
See [more](https://github.com/lvillani/i3-gnome/issues/10).

With `i3-cinnamon` you get along with i3 (Window Manager) and Cinnamon (Desktop Environment) instead of Muffin (the default window manager of Cinnamon).

- Cinnamon screensaver & lockscreen
- Cinnamon power settings
- Cinnamon display management
- HiDPI configuration through Cinnamon
- Cinnamon notification daemon
- Autostart of various applications (XDG-Autostart)
- Background image

# Known issues

- Cinnamon keyboard shortcuts (including volume/media/brightness keys) are not working
- Cinnamon display management (Not working anymore due to changes in Cinnamon, see [#3](https://github.com/jthomaschewski/i3-cinnamon/issues/3))
- i3 exit + login in gdm might cause some issues, login after reboot works fine

# Requirements
* i3-wm
* Cinnamon 5.x (For Cinnamon 4.x use release tagged with 4.x)
* GDM or LightDM (might also work with others)

- i3-wm
- Cinnamon 5.x (For Cinnamon 4.x use release tagged with 4.x)
- GDM or LightDM (might also work with others)

# Installation
* For Arch users see the [AUR package](https://aur.archlinux.org/packages/i3-cinnamon-git/) for a more easy installation.

- For Arch users see the [AUR package](https://aur.archlinux.org/packages/i3-cinnamon-git/) for a more easy installation.

Using `make`:
* download the repo.
* on the terminal go to the repo directory.
* `make install`

- download the repo.
- on the terminal go to the repo directory.
- `make install`

# Contributing

We accept contributions. Any help is greatly appreciated.

For smaller patches and bug fixes just go ahead and either report an issue or submit a pull
request.

0 comments on commit e720fd3

Please sign in to comment.