Skip to content

Commit 2a52569

Browse files
authored
Merge pull request #4 from openSVM/copilot/fix-3
Add mermaid diagrams to README: architecture, dev tools ecosystem, and installation guide
2 parents 07ac07f + cb6cd6a commit 2a52569

File tree

1 file changed

+240
-0
lines changed

1 file changed

+240
-0
lines changed

README.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,190 @@ just dev-tools-check
3636
-**Comprehensive**: From systems programming to AI/ML to blockchain development
3737
-**Production Ready**: Enterprise-grade tools used by top companies
3838

39+
#### Development Tools Ecosystem
40+
41+
```mermaid
42+
mindmap
43+
root((COSMIC SVM<br/>Dev Tools<br/>2,600+))
44+
Programming Languages
45+
Core Languages (25+)
46+
Rust, Go, Python
47+
Node.js, Deno, Bun
48+
Zig, Crystal, Swift
49+
Functional
50+
Clojure, Scala, Haskell
51+
Erlang, Elixir
52+
Scientific
53+
Julia, R, MATLAB
54+
IDEs & Editors (15+)
55+
Modern
56+
VS Code, Cursor IDE
57+
Zed IDE
58+
Enterprise
59+
IntelliJ, Eclipse
60+
WebStorm, NetBeans
61+
Terminal
62+
Vim, Emacs, Helix
63+
Web Development (40+)
64+
Frameworks
65+
React, Angular, Vue
66+
Svelte, SolidJS
67+
Build Tools
68+
Vite, Webpack, esbuild
69+
Rollup, Parcel
70+
Styling
71+
Tailwind, Sass, PostCSS
72+
Cloud & Infrastructure (25+)
73+
Multi-Cloud
74+
AWS, Azure, GCP
75+
DigitalOcean, Linode
76+
IaC
77+
Terraform, Pulumi
78+
Ansible, Chef
79+
Containers
80+
Docker, Podman, k8s
81+
Security & Network (30+)
82+
Scanning
83+
Nmap, Nikto, OpenVAS
84+
Penetration Testing
85+
Metasploit, Burp Suite
86+
VPN
87+
WireGuard, Tailscale, Tor
88+
AI/ML & Blockchain
89+
AI Tools
90+
PyTorch, TensorFlow
91+
Ollama, Transformers
92+
Blockchain
93+
Hardhat, Foundry
94+
Solidity, Web3
95+
Database Systems (20+)
96+
SQL
97+
PostgreSQL, MySQL
98+
NoSQL
99+
MongoDB, Redis, Neo4j
100+
Big Data
101+
Cassandra, InfluxDB
102+
Specialized
103+
Game Dev
104+
Godot, Blender, Unity
105+
Mobile
106+
React Native, Flutter
107+
Scientific
108+
Jupyter, NumPy, SciPy
109+
Media
110+
FFmpeg, OBS, Audacity
111+
```
112+
39113
For complete documentation, see [docs/DEV-TOOLS.md](docs/DEV-TOOLS.md).
40114

41115
---
42116

117+
## Architecture Overview
118+
119+
The COSMIC Desktop Environment is built with a modular architecture that separates core libraries, system services, and user applications:
120+
121+
```mermaid
122+
graph TB
123+
subgraph "COSMIC Libraries & Protocols"
124+
LP[libcosmic]
125+
CP[cosmic-protocols]
126+
CT[cosmic-text]
127+
CTH[cosmic-theme]
128+
CTI[cosmic-time]
129+
end
130+
131+
subgraph "Core System Services"
132+
CS[cosmic-session]
133+
CC[cosmic-comp<br/>Wayland Compositor]
134+
CSD[cosmic-settings-daemon]
135+
CG[cosmic-greeter<br/>Display Manager]
136+
CN[cosmic-notifications]
137+
CI[cosmic-idle]
138+
XDG[xdg-desktop-portal-cosmic]
139+
end
140+
141+
subgraph "Desktop Environment"
142+
CPL[cosmic-panel]
143+
CBG[cosmic-bg]
144+
CL[cosmic-launcher]
145+
COSD[cosmic-osd]
146+
CWE[cosmic-workspaces-epoch]
147+
CA[cosmic-applets]
148+
end
149+
150+
subgraph "User Applications"
151+
CF[cosmic-files]
152+
CE[cosmic-edit]
153+
CTERM[cosmic-term]
154+
CSET[cosmic-settings]
155+
CST[cosmic-store]
156+
CP2[cosmic-player]
157+
CSS[cosmic-screenshot]
158+
CTE[cosmic-theme-editor]
159+
CAL[cosmic-applibrary]
160+
end
161+
162+
subgraph "External Integration"
163+
PL[pop-launcher]
164+
CR[cosmic-randr]
165+
CICO[cosmic-icons]
166+
end
167+
168+
%% Dependencies
169+
LP --> CS
170+
LP --> CC
171+
LP --> CSD
172+
LP --> CPL
173+
LP --> CF
174+
LP --> CE
175+
LP --> CTERM
176+
LP --> CSET
177+
LP --> CST
178+
179+
CP --> CC
180+
CP --> XDG
181+
182+
CT --> CF
183+
CT --> CE
184+
CT --> CTERM
185+
186+
CTH --> CPL
187+
CTH --> CBG
188+
CTH --> CTE
189+
190+
%% System interactions
191+
CS --> CC
192+
CS --> CSD
193+
CS --> CG
194+
CS --> CPL
195+
196+
CC --> CBG
197+
CC --> CPL
198+
CC --> CL
199+
CC --> COSD
200+
CC --> CWE
201+
202+
CSD --> CSET
203+
CSD --> CTH
204+
205+
%% External integrations
206+
PL --> CL
207+
CR --> CSET
208+
CICO --> CPL
209+
CICO --> CF
210+
211+
classDef library fill:#e1f5fe
212+
classDef service fill:#f3e5f5
213+
classDef desktop fill:#e8f5e8
214+
classDef app fill:#fff3e0
215+
classDef external fill:#fce4ec
216+
217+
class LP,CP,CT,CTH,CTI library
218+
class CS,CC,CSD,CG,CN,CI,XDG service
219+
class CPL,CBG,CL,COSD,CWE,CA desktop
220+
class CF,CE,CTERM,CSET,CST,CP2,CSS,CTE,CAL app
221+
class PL,CR,CICO external
222+
```
43223

44224
## Components of COSMIC Desktop
45225
* [cosmic-applets](https://github.com/pop-os/cosmic-applets)
@@ -317,6 +497,66 @@ We do our best to keep the referenced submodule commits in this repository build
317497

318498
Notes on versioning and packaging all these components together properly will be added at a later stage once COSMIC DE gets its first release.
319499

500+
## Installation Guide
501+
502+
Choose your installation method based on your distribution and needs:
503+
504+
```mermaid
505+
flowchart TD
506+
Start([Want to install COSMIC?]) --> OS{Which OS?}
507+
508+
OS -->|Pop!_OS| PopOS[Pop!_OS]
509+
OS -->|Arch Linux| Arch[Arch Linux]
510+
OS -->|Fedora| Fedora[Fedora]
511+
OS -->|NixOS| NixOS[NixOS]
512+
OS -->|openSUSE| SUSE[openSUSE Tumbleweed]
513+
OS -->|Gentoo| Gentoo[Gentoo]
514+
OS -->|Other| Other[Other Distribution]
515+
516+
PopOS --> PopVer{Which version?}
517+
PopVer -->|24.04 Alpha| Pop24[✅ Recommended<br/>Latest features]
518+
PopVer -->|22.04 LTS| Pop22[⚠️ Legacy<br/>Limited updates]
519+
520+
Pop24 --> PopInstall[Install from ISO<br/>or upgrade with<br/>pop-upgrade]
521+
Pop22 --> PopLegacy[Enable Wayland<br/>+ Install cosmic-session]
522+
523+
Arch --> ArchInstall[pacman -S cosmic-session<br/>or pacman -S cosmic]
524+
Fedora --> FedoraInstall[dnf copr enable ryanabx/cosmic-epoch<br/>dnf install cosmic-desktop]
525+
NixOS --> NixInstall[Add to configuration.nix:<br/>services.desktopManager.cosmic.enable = true]
526+
SUSE --> SUSEInstall[opi patterns-cosmic<br/>Select X11:COSMIC:Factory]
527+
Gentoo --> GentooInstall[Add cosmic-overlay<br/>emerge cosmic-meta]
528+
529+
Other --> BuildChoice{Build from source?}
530+
BuildChoice -->|Yes| BuildSource[Install dependencies<br/>+ git clone --recurse-submodules<br/>+ just sysext]
531+
BuildChoice -->|No| Wait[Wait for your distro<br/>to package COSMIC]
532+
533+
PopInstall --> Login[Log out → Select COSMIC<br/>at login screen]
534+
PopLegacy --> Login
535+
ArchInstall --> Login
536+
FedoraInstall --> Login
537+
NixInstall --> Login
538+
SUSEInstall --> Login
539+
GentooInstall --> Login
540+
BuildSource --> SystemExt[Move cosmic-sysext to<br/>/var/lib/extensions<br/>+ systemctl enable systemd-sysext]
541+
SystemExt --> Login
542+
543+
Login --> DevTools{Need dev tools?}
544+
DevTools -->|Yes| InstallTools[just dev-tools<br/>2,600+ tools installed]
545+
DevTools -->|No| Enjoy[🎉 Enjoy COSMIC!]
546+
InstallTools --> CheckTools[just dev-tools-check<br/>Verify installation]
547+
CheckTools --> Enjoy
548+
549+
classDef recommended fill:#c8e6c9
550+
classDef warning fill:#ffecb3
551+
classDef action fill:#e1f5fe
552+
classDef end fill:#f3e5f5
553+
554+
class Pop24,PopInstall recommended
555+
class Pop22,PopLegacy warning
556+
class ArchInstall,FedoraInstall,NixInstall,SUSEInstall,GentooInstall,BuildSource,SystemExt,InstallTools,CheckTools action
557+
class Enjoy end
558+
```
559+
320560
## Installing on Pop!\_OS
321561

322562
COSMIC DE is in its first alpha release. Using and testing the alpha is welcome. Bugs and breakage are expected.

0 commit comments

Comments
 (0)