Skip to content

Commit

Permalink
Add source files
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffmhubbard committed Oct 8, 2022
0 parents commit 83362a6
Show file tree
Hide file tree
Showing 12 changed files with 194 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019-2022 Jeff M. Hubbard

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
85 changes: 85 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# The Penguin Desktop

The [Penguin Desktop](https://penguin.fyi) is a light-weight, general-purpose, [X](https://x.org)/[XDG](https://www.freedesktop.org/wiki/Specifications/)/[GTK](https://gtk.org/)-centric Desktop Environment for [Arch Linux](https://archlinux.org) based on [AwesomeWM](https://awesomewm.org).

![Penguin Desktop R15](https://github.com/penguin-fyi/.github/profile/penguin-desktop-15.png)

## About



### Features

* User-friendly, traditionally styled UI combined with dynamic window tiling
* Equally balanced mouse and keyboard controls with consistent, layered design
* Good selection of default apps (including xed, xreader, xviewer, xplayer from X-Apps)
* Made with real penguins

## Installation
There are currently several ways to install Penguin Desktop.

#### New Install (manual)
Installing Penguin Desktop during a manual Arch Linux installation is the most straight-forward, and therefore most recommended, method. We will not cover the entire Arch Linux install; can read more about that [here](https://wiki.archlinux.org/title/Installation_guide).

**Step 1:** Follow Arch install guide up to ***Select the mirrors***

**Step 2:** Add the Penguin mirrorlist, by creating `/etc/pacman.d/mirrorlist-penguin`

Server = https://repo.penguin.fyi/packages/$repo/$arch
SigLevel = Optional TrustAll

**Step 3:** Add mirrorlist to `/etc/pacman.conf`

[penguin]
Include = /etc/pacman.d/mirrorlist-penguin

**Step 4:** Install complete Penguin Desktop

pacstrap /mnt penguin-base penguin-desktop

**Step 5:** Continue Arch install as usual

#### New Install (archinstall)
Installing Penguin Desktop during Arch installation via `archinstall` is also possible. This method is two part: `archinstall` and `arch-chroot`

##### archinstall:
In this part of the installation, you may setup your system as needed, but the following points are required.

* Do not create **User account**; this will be done later
* For **Profile**; choose **minimal**
* For **Audio**; choose **pipewire**
* For **Network configuration**; choose **NetworkManager**

When the installation is complete, select **Yes** to enter `chroot`

##### arch-chroot:
**Step 1**: Run setup script to add mirrorlist and install

curl https://repo.penguin.fyi/setup_mini.sh | sh

**Step 2**: Add **User Account**

useradd -m username
passwd username

**Step 3**: Exit `chroot` with `Ctrl+D` and reboot to new system

#### Existing Install [unsupported]

...

#### Via PKGBUILD [unsupported]

...

## Support

To get help with Penguin Desktop, please open an issue on the appropriate repository
| | |
|-|-|
| [pkgbuilds](https://github.com/penguin-fyi/pkgbuilds/issues) | For issues building or installing the packages |
| [awescome-config](https://github.com/penguin-fyi/awesome-config/issues) | For issues with AwesomeWM |
| [desktop-config](https://github.com/penguin-fyi/awesome-config/issues) | For issues with the default desktop configuration (`/etc/skel`) |

Nothing is documented. Maybe [this](https://wiki.archlinux.org/) will help.

10 changes: 10 additions & 0 deletions autostart/nitrogen.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=Wallpaper setter
Comment=Browse and set desktop backgrounds
Icon=nitrogen
Type=Application
StartupNotify=true
Terminal=false
Exec=nitrogen --restore
10 changes: 10 additions & 0 deletions autostart/numlockx.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=numlockx
Comment=Enable numlock
Icon=numlock-enabled-symbolic
Type=Application
StartupNotify=false
Terminal=false
Exec=numlockx
10 changes: 10 additions & 0 deletions autostart/pcmanfm.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=File Manager PCManFM
Comment=Browse the file system and manage the files
Icon=system-file-manager
Type=Application
StartupNotify=false
Terminal=false
Exec=pcmanfm -d --desktop-off
10 changes: 10 additions & 0 deletions autostart/picom.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=picom
Comment=A X compositor
Icon=
Type=Application
StartupNotify=false
Terminal=false
Exec=picom -b
6 changes: 6 additions & 0 deletions autostart/polkit-gnome.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[Desktop Entry]
Name=GNOME Polkit Agent
Exec=/usr/lib/polkit-gnome/polkit-gnome-authentication-agent-1
Terminal=false
Type=Application
StartupNotify=false
6 changes: 6 additions & 0 deletions autostart/udiskie.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[Desktop Entry]
Name=udiskie
Exec=udiskie -s -A
Terminal=false
Type=Application
StartupNotify=false
10 changes: 10 additions & 0 deletions autostart/unclutter.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=unclutter
Comment=Hide mouse cursor
Icon=tool-pointer
Type=Application
StartupNotify=false
Terminal=false
Exec=unclutter --exclude-root -b
10 changes: 10 additions & 0 deletions autostart/volumeicon.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=volumeicon
Comment=Lightweight volume control for the systray
Icon=multimedia-volume-control
Type=Application
StartupNotify=false
Terminal=false
Exec=volumeicon
10 changes: 10 additions & 0 deletions autostart/xdg-user-dirs.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Version=1.0
Encoding=UTF-8
Name=User folders update
Comment=Update common folders names to match current locale
Icon=multimedia-volume-control
Type=Application
StartupNotify=false
Terminal=false
Exec=xdg-user-dirs-gtk-update
6 changes: 6 additions & 0 deletions xsessions/awesome-default.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[Desktop Entry]
Name=awesome (fallback)
Comment=Default Awesome rc.lua
Exec=awesome -c /etc/xdg/awesome/rc.lua
TryExec=awesome
Type=Application

0 comments on commit 83362a6

Please sign in to comment.