├── .gitignore
├── scripts
    └── tag.sh
├── .github
    └── workflows
    │   └── ci.yml
├── docs
    └── DEBUGGING.md
├── .gitmodules
├── justfile
├── TRADEMARK.md
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | .vscode
2 | cosmic-sysext
3 | *_build


--------------------------------------------------------------------------------
/scripts/tag.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | set -e
 4 | 
 5 | TAG="$1"
 6 | 
 7 | if [ -z "$TAG" ]
 8 | then
 9 |     echo "$0 [tag]" >&2
10 |     exit 1
11 | fi
12 | 
13 | echo "Do you want to tag the current state of cosmic-epoch with the tag $TAG? (y/N)"
14 | read answer
15 | if [ "$answer" != "y" ]
16 | then
17 |     echo "Did not answer y, exiting" >&2
18 |     exit 1
19 | fi
20 | 
21 | set -x
22 | 
23 | git fetch --recurse-submodules
24 | 
25 | git tag --force "$TAG"
26 | git submodule foreach git tag --force "$TAG"
27 | 
28 | git push --force origin tag "$TAG"
29 | git submodule foreach git push --force origin tag "$TAG"
30 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | # Use Arch to test build outside of Ubuntu/Pop.
 2 | #
 3 | # Tests with recent version of dependencies. Another testson a different
 4 | # distro could be used to test for lowest supported.
 5 | #
 6 | # A minimal image should also help to confirm what dependencies are needed.
 7 | 
 8 | name: CI
 9 | 
10 | on:
11 |   pull_request:
12 |   push:
13 |   schedule:
14 |     - cron: '0 7 * * *' # Midnight MST daily
15 | 
16 | jobs:
17 |   Test:
18 |     runs-on: ubuntu-latest
19 |     container:
20 |       image: archlinux:latest
21 |       volumes:
22 |         - /:/host
23 |     steps:
24 |     - run: >
25 |         pacman --noconfirm -Syu
26 |         base-devel
27 |         cargo
28 |         clang
29 |         desktop-file-utils
30 |         git
31 |         gtk3
32 |         gtk4
33 |         just
34 |         libinput
35 |         libxkbcommon
36 |         llvm
37 |         mesa
38 |         meson
39 |         pipewire
40 |         pulseaudio
41 |         seatd
42 |         wayland
43 |         lld
44 |         expat
45 |         fontconfig
46 |         freetype2
47 |         flatpak
48 |         nasm
49 |     - run: rm -rf /host/usr/local/lib/android # Free space
50 |     - uses: actions/checkout@v3
51 |       with:
52 |         submodules: recursive
53 |     # Safe directory behavior seems to have issues with `container:`
54 |     # https://github.com/actions/checkout/issues/915
55 |     - run: git config --global --add safe.directory '*'
56 |     - run: just sysext
57 | 


--------------------------------------------------------------------------------
/docs/DEBUGGING.md:
--------------------------------------------------------------------------------
 1 | Debugging COSMIC
 2 | ================
 3 | 
 4 | An assortment of useful tools and settings for debugging COSMIC.
 5 | 
 6 | ## Logs
 7 | Cosmic-comp, cosmic-panel, and other components log to `stderr`, as well as journald (if present).
 8 | 
 9 | ## Wayland and X11 Protocols
10 | 
11 | Run clients with `WAYLAND_DEBUG=1` to see what wayland calls are made. `xtrace -n <command>` can be used to see what X calls an X11 client is making.
12 | 
13 | ## XWayland
14 | 
15 | A tool like `xprop` can be used to determine if an application is running in XWayland. If `xprop` is unable to select a window, it is a native Wayland window.
16 | 
17 | ## Performance
18 | 
19 | `sudo perf top` can be used to see what functions, across all processes, are using the most CPU time. The `-p` argument can be used to restrict this to a single process. The output is more useful for executables with debug symbols.
20 | 
21 | `cosmic-comp` integrates Tracy for profiling. It can be built with `cargo build --features profile-with-tracy --profile fastdebug`, then the Tracy client can connect from the same system or a different one
22 | 
23 | ## Graphics drivers
24 | `eglinfo` and `vulkaninfo` indicate what graphics cards and drivers are in use for hardware-accelerated rendering.
25 | 
26 | On systems with NVIDIA graphics, `nvidia-smi` has information about the GPU and driver.
27 | 
28 | ## DRM
29 | The Linux DRM subsystem handles graphics cards and display controllers.
30 | 
31 | `drm_info` prints information about the outputs, planes, etc. associated with each GPU and their properties. The output of this command can be useful for understanding display related issues.
32 | 
33 | https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/DRM-Debugging documents how to configure DRM to enable additional logging, which can be useful for understanding some DRM driver issues.
34 | 
35 | ## Frozen desktop
36 | 
37 | If the desktop is frozen and `ctrl+alt+f*` don't work to change to a TTY, [the magic SysRq key](https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html) with `r` can be used to swich input in raw mode, so the kernel will handle the tty switch key binding. /etc/sysctl.conf` or `/etc/sysctl.d` may need to be edited first to set `kernel.sysrq=1` or another value that allows this command.
38 | 
39 | It is also possible to connect over `ssh` from another computer.
40 | 
41 | Then `pidof cosmic-comp` can be used to get the PID of the compositor. Then it is possible to investigate further with tools like `gdb`, using `sudo gdb` then `attach <pid>`.
42 | 


--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
 1 | [submodule "cosmic-session"]
 2 |     path = cosmic-session
 3 |     url = https://github.com/pop-os/cosmic-session
 4 |     branch = master
 5 | [submodule "cosmic-comp"]
 6 |     path = cosmic-comp
 7 |     url = https://github.com/pop-os/cosmic-comp
 8 |     branch = master
 9 | [submodule "cosmic-panel"]
10 |     path = cosmic-panel
11 |     url = https://github.com/pop-os/cosmic-panel
12 |     branch = master
13 | [submodule "cosmic-applets"]
14 |     path = cosmic-applets
15 |     url = https://github.com/pop-os/cosmic-applets
16 |     branch = master
17 | [submodule "cosmic-applibrary"]
18 |     path = cosmic-applibrary
19 |     url = https://github.com/pop-os/cosmic-applibrary
20 |     branch = master
21 | [submodule "cosmic-launcher"]
22 |     path = cosmic-launcher
23 |     url = https://github.com/pop-os/cosmic-launcher
24 |     branch = master
25 | [submodule "simple-wrapper"]
26 |     path = simple-wrapper
27 |     url = https://github.com/pop-os/simple-wrapper
28 |     branch = master
29 | [submodule "cosmic-settings"]
30 |     path = cosmic-settings
31 |     url = https://github.com/pop-os/cosmic-settings
32 |     branch = master
33 | [submodule "cosmic-settings-daemon"]
34 |     path = cosmic-settings-daemon
35 |     url = https://github.com/pop-os/cosmic-settings-daemon
36 |     branch = master
37 | [submodule "xdg-desktop-portal-cosmic"]
38 |     path = xdg-desktop-portal-cosmic
39 |     url = https://github.com/pop-os/xdg-desktop-portal-cosmic.git
40 |     branch = master
41 | [submodule "cosmic-osd"]
42 |     path = cosmic-osd
43 |     url = https://github.com/pop-os/cosmic-osd.git
44 |     branch = master
45 | [submodule "cosmic-bg"]
46 |     path = cosmic-bg
47 |     url = https://github.com/pop-os/cosmic-bg.git
48 |     branch = master
49 | [submodule "cosmic-workspaces-epoch"]
50 |     path = cosmic-workspaces-epoch
51 |     url = https://github.com/pop-os/cosmic-workspaces-epoch/
52 |     branch = master
53 | [submodule "cosmic-notifications"]
54 |     path = cosmic-notifications
55 |     url = https://github.com/pop-os/cosmic-notifications
56 |     branch = master
57 | [submodule "cosmic-icons"]
58 |     path = cosmic-icons
59 |     url = https://github.com/pop-os/cosmic-icons.git
60 |     branch = master
61 | [submodule "cosmic-greeter"]
62 |     path = cosmic-greeter
63 |     url = https://github.com/pop-os/cosmic-greeter
64 |     branch = master
65 | [submodule "cosmic-screenshot"]
66 |     path = cosmic-screenshot
67 |     url = https://github.com/pop-os/cosmic-screenshot
68 |     branch = master
69 | [submodule "cosmic-edit"]
70 |     path = cosmic-edit
71 |     url = https://github.com/pop-os/cosmic-edit
72 |     branch = master
73 | [submodule "cosmic-term"]
74 |     path = cosmic-term
75 |     url = https://github.com/pop-os/cosmic-term.git
76 |     branch = master
77 | [submodule "cosmic-randr"]
78 |     path = cosmic-randr
79 |     url = https://github.com/pop-os/cosmic-randr.git
80 |     branch = master
81 | [submodule "cosmic-files"]
82 |     path = cosmic-files
83 |     url = https://github.com/pop-os/cosmic-files.git
84 |     branch = master
85 | [submodule "cosmic-store"]
86 |     path = cosmic-store
87 |     url = https://github.com/pop-os/cosmic-store.git
88 |     branch = master
89 | [submodule "cosmic-wallpapers"]
90 | 	path = cosmic-wallpapers
91 | 	url = https://github.com/pop-os/cosmic-wallpapers.git
92 | 	branch = master
93 | [submodule "cosmic-idle"]
94 | 	path = cosmic-idle
95 | 	url = https://github.com/pop-os/cosmic-idle.git
96 | 	branch = master
97 | 


--------------------------------------------------------------------------------
/justfile:
--------------------------------------------------------------------------------
 1 | set dotenv-load
 2 | just := just_executable()
 3 | make := `which make`
 4 | 
 5 | build:
 6 |     mkdir -p build
 7 |     {{ just }} cosmic-applets/build-release
 8 |     {{ just }} cosmic-applibrary/build-release
 9 |     {{ just }} cosmic-bg/build-release
10 |     {{ make }} -C cosmic-comp all
11 |     {{ just }} cosmic-edit/build-release
12 |     {{ just }} cosmic-files/build-release
13 |     {{ just }} cosmic-greeter/build-release
14 |     {{ just }} cosmic-idle/build-release
15 |     {{ just }} cosmic-launcher/build-release
16 |     {{ just }} cosmic-notifications/build-release
17 |     {{ make }} -C cosmic-osd all
18 |     {{ just }} cosmic-panel/build-release
19 |     {{ just }} cosmic-randr/build-release
20 |     {{ just }} cosmic-screenshot/build-release
21 |     {{ just }} cosmic-settings/build-release
22 |     {{ make }} -C cosmic-settings-daemon all
23 |     {{ just }} cosmic-session/all
24 |     {{ just }} cosmic-store/build-release
25 |     {{ just }} cosmic-term/build-release
26 |     {{ make }} -C cosmic-wallpapers all
27 |     {{ make }} -C cosmic-workspaces-epoch all
28 |     {{ make }} -C xdg-desktop-portal-cosmic all
29 | 
30 | install rootdir="" prefix="/usr/local": build
31 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-applets/install
32 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-applibrary/install
33 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-bg/install
34 |     {{ make }} -C cosmic-comp install DESTDIR={{rootdir}} prefix={{prefix}}
35 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-edit/install
36 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-files/install
37 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-greeter/install
38 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-icons/install
39 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-idle/install
40 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-launcher/install
41 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-notifications/install
42 |     {{ make }} -C cosmic-osd install DESTDIR={{rootdir}} prefix={{prefix}}
43 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-panel/install
44 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-randr/install
45 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-screenshot/install
46 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-settings/install
47 |     {{ make }} -C cosmic-settings-daemon install DESTDIR={{rootdir}} prefix={{prefix}}
48 |     {{ just }} rootdir={{rootdir}} prefix={{rootdir + prefix}} cosmic-session/install
49 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-store/install
50 |     {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-term/install
51 |     {{ make }} -C cosmic-wallpapers install DESTDIR={{rootdir}} prefix={{prefix}}
52 |     {{ make }} -C cosmic-workspaces-epoch install DESTDIR={{rootdir}} prefix={{prefix}}
53 |     {{ make }} -C xdg-desktop-portal-cosmic install DESTDIR={{rootdir}} prefix={{prefix}}
54 | 
55 | _mkdir dir:
56 |    mkdir -p dir
57 | 
58 | sysext dir=(invocation_directory() / "cosmic-sysext") version=("nightly-" + `git rev-parse --short HEAD`): (_mkdir dir) (install dir "/usr")
59 |     #!/usr/bin/env sh
60 |     mkdir -p {{dir}}/usr/lib/extension-release.d/
61 |     cat >{{dir}}/usr/lib/extension-release.d/extension-release.cosmic-sysext <<EOF
62 |     NAME="Cosmic DE"
63 |     VERSION={{version}}
64 |     $(cat /etc/os-release | grep '^ID=')
65 |     $(cat /etc/os-release | grep '^VERSION_ID=')
66 |     EOF
67 |     echo "Done"
68 | 
69 | clean:
70 |     rm -rf cosmic-sysext
71 |     rm -rf cosmic-applets/target
72 |     rm -rf cosmic-applibrary/target
73 |     rm -rf cosmic-bg/target
74 |     rm -rf cosmic-comp/target
75 |     rm -rf cosmic-edit/target
76 |     {{ just }} cosmic-files/clean
77 |     rm -rf cosmic-greeter/target
78 |     {{ just }} cosmic-idle/clean
79 |     rm -rf cosmic-launcher/target
80 |     rm -rf cosmic-panel/target
81 |     rm -rf cosmic-notifications/target
82 |     rm -rf cosmic-osd/target
83 |     rm -rf cosmic-randr/target
84 |     rm -rf cosmic-screenshot/target
85 |     rm -rf cosmic-settings/target
86 |     rm -rf cosmic-settings-daemon/target
87 |     rm -rf cosmic-session/target
88 |     {{ just }} cosmic-store/clean
89 |     {{ just }} cosmic-term/clean
90 |     {{ make }} -C cosmic-wallpapers clean
91 |     rm -rf cosmic-workspaces-epoch/target
92 |     rm -rf xdg-desktop-portal-cosmic/target
93 | 


--------------------------------------------------------------------------------
/TRADEMARK.md:
--------------------------------------------------------------------------------
 1 | # COSMIC Trademark Policy
 2 | 
 3 | This document outlines the policy regarding the use of the COSMIC desktop environment trademark owned by System76. The purpose of this policy is to ensure that the COSMIC trademark is used correctly and consistently, maintaining the integrity and reputation of the COSMIC brand.
 4 | 
 5 | 1. Usage of the COSMIC Trademark
 6 |     1. The COSMIC trademark includes, but is not limited to, the name "COSMIC", “COSMIC DE” the COSMIC logo, and any associated symbols or designs.
 7 |     2. The COSMIC trademark may only be used in accordance with this policy. Unauthorized use of the trademark is prohibited.
 8 | 2. Permissible Use
 9 |     1. Community Projects: Community projects such as Linux distributions may use the COSMIC trademark to refer to the desktop environment, provided that such use is not misleading and does not imply endorsement by System76 without explicit permission.
10 |     2. Educational and Informational Use: The COSMIC trademark may be used in educational and informational materials, including books, websites, and articles, to refer to the desktop environment, provided that such use complies with the guidelines set forth in this policy.
11 |     3. Marketing and Promotional Use: Partners and affiliates of System76 may use the COSMIC trademark in marketing and promotional materials with prior written consent from System76.
12 | 3. Prohibited Use
13 |     1. Misrepresentation: The COSMIC trademark must not be used in a way that misrepresents or implies false association with, endorsement by, or sponsorship from System76.
14 |     2. Modification: The COSMIC trademark must not be altered, modified, or used as part of another trademark or logo without prior written permission from System76.
15 |     3. Merchandising: The COSMIC trademark must not be used on merchandise (e.g., T-shirts, mugs) for commercial purposes without explicit authorization from System76.
16 | 4. Logo Usage Guidelines
17 |     1. The COSMIC logo must be used as provided by System76 without any modifications. This includes maintaining the logo’s colors, proportions, and overall design.
18 |     2. The COSMIC logo must be displayed in a manner that is clear and legible. Sufficient clear space should be maintained around the logo to ensure it is not crowded by other visual elements.
19 |     3. The COSMIC name should be identified as a trademark using the “™” symbol.
20 | 5. Official COSMIC Software
21 |     1. Software hosted at [System76's GitHub repository](https://github.com/pop-os) is considered official COSMIC software. Only software that has been approved by System76 is permitted to use the COSMIC trademarks to refer to itself. Applications and applets that are official COSMIC software use the “cosmic-” package namespace and “com.system76.” prefixed App ID. Other applications should avoid using these prefixes.
22 |     2. Third-party applications, applets, and software that integrate with or extend the COSMIC desktop environment must not use the COSMIC trademark in a way that implies official status or endorsement without prior approval from System76. Third-party developers are encouraged to use the "cosmic-ext-" package namespace. These applications and applets may be described as "for the COSMIC™ desktop".
23 |     3. Third-party applications and applets may request inclusion as official COSMIC software. To request inclusion, please contact System76 at cosmic@system76.com.
24 | 6. Request for Permission
25 |     1. To request permission for uses of the COSMIC trademark not covered by this policy, please contact System76 at trademark@system76.com.
26 |     2. All requests will be reviewed on a case-by-case basis, and System76 reserves the right to grant or deny permission at its sole discretion.
27 | 7. Enforcement
28 |     1. System76 reserves the right to take appropriate legal action against any unauthorized use of the COSMIC trademark.
29 |     2. System76 may, at its discretion, require the cessation of use of the COSMIC trademark by any party that fails to comply with this policy.
30 | 
31 | ## Contact Information
32 | 
33 | For any questions or to request permission to use the COSMIC trademark, please contact:<br><br>
34 | System76, Inc.<br>
35 | trademark@system76.com<br><br>
36 | This trademark policy is effective as of June 3, 2024 and may be updated from time to time at the discretion of System76.
37 | 
38 | ---
39 | By adhering to these guidelines, you help us protect the COSMIC brand and ensure it remains a symbol of quality and innovation. Thank you for your cooperation.
40 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # COSMIC Desktop
  2 | 
  3 | Currently an incomplete **alpha**. Testing instructions below for various distributions.
  4 | 
  5 | 
  6 | ## Components of COSMIC Desktop
  7 | * [cosmic-applets](https://github.com/pop-os/cosmic-applets)
  8 | * [cosmic-applibrary](https://github.com/pop-os/cosmic-applibrary)
  9 | * [cosmic-bg](https://github.com/pop-os/cosmic-bg)
 10 | * [cosmic-comp](https://github.com/pop-os/cosmic-comp)
 11 | * [cosmic-edit](https://github.com/pop-os/cosmic-edit)
 12 | * [cosmic-files](https://github.com/pop-os/cosmic-files)
 13 | * [cosmic-greeter](https://github.com/pop-os/cosmic-greeter)
 14 | * [cosmic-icons](https://github.com/pop-os/cosmic-icons)
 15 | * [cosmic-launcher](https://github.com/pop-os/cosmic-launcher)
 16 | * [cosmic-notifications](https://github.com/pop-os/cosmic-notifications)
 17 | * [cosmic-osd](https://github.com/pop-os/cosmic-osd)
 18 | * [cosmic-panel](https://github.com/pop-os/cosmic-panel)
 19 | * [cosmic-randr](https://github.com/pop-os/cosmic-randr)
 20 | * [cosmic-screenshot](https://github.com/pop-os/cosmic-screenshot)
 21 | * [cosmic-session](https://github.com/pop-os/cosmic-session)
 22 | * [cosmic-settings](https://github.com/pop-os/cosmic-settings)
 23 | * [cosmic-settings-daemon](https://github.com/pop-os/cosmic-settings-daemon)
 24 | * [cosmic-store](https://github.com/pop-os/cosmic-store)
 25 | * [cosmic-term](https://github.com/pop-os/cosmic-term)
 26 | * [cosmic-theme-editor](https://github.com/pop-os/cosmic-theme-editor)
 27 | * [cosmic-workspaces-epoch](https://github.com/pop-os/cosmic-workspaces-epoch)
 28 | * [xdg-desktop-portal-cosmic](https://github.com/pop-os/xdg-desktop-portal-cosmic)
 29 | * [pop-launcher](https://github.com/pop-os/launcher)
 30 | 
 31 | ### COSMIC libraries/crates
 32 | 
 33 | * [cosmic-protocols](https://github.com/pop-os/cosmic-protocols)
 34 | * [cosmic-text](https://github.com/pop-os/cosmic-text)
 35 | * [cosmic-theme](https://github.com/pop-os/cosmic-theme)
 36 | * [cosmic-time](https://github.com/pop-os/cosmic-time)
 37 | * [libcosmic](https://github.com/pop-os/libcosmic)
 38 | 
 39 | ## Setup on distributions without packaging of cosmic components
 40 | 
 41 | The COSMIC desktop environment requires a few dependencies:
 42 | (This list does not try to be exhaustive, but rather tries to provide a decent starting point. For detailed instructions, check out the individual projects):
 43 | 
 44 | - [just](https://github.com/casey/just)
 45 | - rustc
 46 | - libwayland
 47 | - mesa (or third-party libEGL/libGL implementations, though interfacing with mesa's libglvnd is generally recommended).
 48 | - libseat
 49 | - libxkbcommon
 50 | - libinput
 51 | - udev
 52 | - dbus
 53 | 
 54 | optionally (though the build-system might currently require these libraries):
 55 | - libsystem
 56 | - libpulse
 57 | - pop-launcher
 58 | - libexpat1
 59 | - libfontconfig
 60 | - libfreetype
 61 | - lld
 62 | - cargo
 63 | - libgbm-dev
 64 | - libclang-dev
 65 | - libpipewire-0.3-dev
 66 | 
 67 | Note: `libfontconfig`, `libfreetype`, and `lld` are packages specific to Linux distributions. You may need to find the equivalent version for your distribution if you are not using Pop!_OS.
 68 | 
 69 | The required ones can be installed with:
 70 | ```
 71 | sudo apt install just rustc libglvnd-dev libwayland-dev libseat-dev libxkbcommon-dev libinput-dev udev dbus libdbus-1-dev libpam0g-dev libpixman-1-dev libssl-dev libflatpak-dev git-lfs -y
 72 | ```
 73 | 
 74 | and the optional ones with:
 75 | ```
 76 | sudo apt install libsystemd-dev libpulse-dev pop-launcher libexpat1-dev libfontconfig-dev libfreetype-dev mold cargo libgbm-dev libclang-dev libpipewire-0.3-dev -y
 77 | ```
 78 | 
 79 | They can be installed all at once with:
 80 | ```
 81 | sudo apt install just rustc libglvnd-dev libwayland-dev libseat-dev libxkbcommon-dev libinput-dev udev dbus libdbus-1-dev libsystemd-dev libpixman-1-dev libssl-dev libflatpak-dev libpulse-dev pop-launcher libexpat1-dev libfontconfig-dev libfreetype-dev mold cargo libgbm-dev libclang-dev libpipewire-0.3-dev libpam0g-dev -y
 82 | ```
 83 | 
 84 | ### Testing
 85 | 
 86 | The easiest way to test COSMIC DE currently is by building a systemd system extension (see `man systemd-sysext`).
 87 | 
 88 | ```
 89 | git clone --recurse-submodules https://github.com/pop-os/cosmic-epoch
 90 | cd cosmic-epoch
 91 | just sysext
 92 | ```
 93 | 
 94 | This will create a system-extension called `cosmic-sysext`, that you can move (without renaming!) into e.g. `/var/lib/extensions`.
 95 | After starting systemd-sysext.service (`sudo systemctl enable --now systemd-sysext`) and refreshing (`sudo systemd-sysext refresh`) or rebooting,
 96 | *COSMIC* will be an available option in your favorite display manager.
 97 | 
 98 | If you have SELinux enabled (e.g. on Fedora), the installed extension won't have the correct labels applied.
 99 | To test COSMIC, you can temporarily disable it and restart `gdm` (note that this will close your running programs).
100 | 
101 | ```shell
102 | sudo setenforce 0
103 | sudo systemctl restart gdm
104 | ```
105 | 
106 | **Note**: An extension created this way will be linked against specific libraries on your system and will not work on other distributions.
107 | It also requires the previously mentioned libraries/dependencies at runtime to be installed in your system (the system extension does not carry these libraries).
108 | 
109 | **Read-Only Filesystem**: If you're not on an immutable distro you may notice that `/usr/` and `/opt/` are read-only.
110 | this is caused by `systemd-sysext` being enabled, when you are done testing you can disable `systemd-sysext` (`sudo systemctl disable --now systemd-sysext`)
111 | 
112 | It is thus no proper method for long term deployment.
113 | 
114 | ### Packaging
115 | 
116 | COSMIC DE is packaged for Pop!_OS. For reference, look at the `debian` folders in the projects repositories.
117 | These and the `justfile` inside this repository may be used as references on how to package COSMIC DE, though no backwards-compatibility guarantees are provided at this stage.
118 | 
119 | ### Versioning
120 | 
121 | COSMIC DE is very much still work-in-progress and thus does not follow a versioning scheme so far.
122 | We do our best to keep the referenced submodule commits in this repository building and working together, as a consequence they might not contain the latest updates and features from these repositories (yet).
123 | 
124 | Notes on versioning and packaging all these components together properly will be added at a later stage once COSMIC DE gets its first release.
125 | 
126 | ## Installing on Pop!_OS
127 | COSMIC DE is in its first alpha release. Using and testing the alpha is welcome. Bugs and breakage are expected.
128 | 
129 | #### Enable Wayland
130 | `sudo nano /etc/gdm3/custom.conf`
131 | 
132 | Change `WaylandEnable` to `true`:
133 | ```
134 | WaylandEnable=true
135 | ```
136 | 
137 | Reboot for this change to take effect.
138 | 
139 | #### Update udev rules for NVIDIA users
140 | 
141 | ```shell
142 | sudo nano /usr/lib/udev/rules.d/61-gdm.rules
143 | ```
144 | 
145 | Look for `LABEL="gdm_prefer_xorg"` and `LABEL="gdm_disable_wayland"`. Add `#` to the `RUN` statements so they look like this:
146 | 
147 | ```
148 | LABEL="gdm_prefer_xorg"
149 | #RUN+="/usr/libexec/gdm-runtime-config set daemon PreferredDisplayServer xorg"
150 | GOTO="gdm_end"
151 | 
152 | LABEL="gdm_disable_wayland"
153 | #RUN+="/usr/libexec/gdm-runtime-config set daemon WaylandEnable false"
154 | GOTO="gdm_end"
155 | ```
156 | 
157 | Restart gdm
158 | 
159 | ```shell
160 | sudo systemctl restart gdm
161 | ```
162 | 
163 | #### Install COSMIC
164 | `sudo apt install cosmic-session`
165 | 
166 | After logging out, click on your user and there will be a sprocket at the bottom right. Change the setting to COSMIC. Proceed to log in.
167 | 
168 | ## Installing on Arch Linux
169 | Install via [cosmic-session](https://archlinux.org/packages/extra/x86_64/cosmic-session/) or the [cosmic](https://archlinux.org/groups/x86_64/cosmic/) group, e.g.:
170 | `pacman -S cosmic-session` or `pacman -S cosmic`
171 | 
172 | Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
173 | For a more detailed discussion, consider the [relevant section in the Arch wiki](https://wiki.archlinux.org/title/COSMIC).
174 | 
175 | ## Installing on Fedora Linux
176 | Cosmic may be installed via a Fedora COPR repository.
177 | ```
178 | dnf copr enable ryanabx/cosmic-epoch
179 | dnf install cosmic-desktop
180 | ```
181 | 
182 | Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
183 | For further information, you may check the [COPR page](https://copr.fedorainfracloud.org/coprs/ryanabx/cosmic-epoch/).
184 | 
185 | ## Installing on openSUSE tumbleweed 
186 | Cosmic can be installed by adding X11:COSMIC:Factory repo with opi.
187 | ```
188 | opi patterns-cosmic
189 | ```
190 | Select X11:COSMIC:Factory, after installing keep the repo.
191 | 
192 | Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
193 | For further information, you may check the [OBS page](https://build.opensuse.org/project/show/X11:COSMIC:Factory).
194 | 
195 | ## Installing on Gentoo Linux
196 | COSMIC can be installed on Gentoo via a custom overlay. Add the overlay using your preferred overlay manager (such as eselect), and then install the desktop environment:
197 | 
198 | `eselect repository add cosmic-overlay git https://github.com/fsvm88/cosmic-overlay.git`
199 | 
200 | Next, install the COSMIC desktop environment and its associated themes:
201 | 
202 | `emerge -1 cosmic-meta pop-theme-meta -pv`
203 | 
204 | Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
205 | For further information, you may check the [Overlay Repository](https://github.com/fsvm88/cosmic-overlay).
206 | 
207 | ## Contact
208 | - [Mattermost](https://chat.pop-os.org/)
209 | - [Twitter](https://twitter.com/pop_os_official)
210 | - [Instagram](https://www.instagram.com/pop_os_official/)
211 | 


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