Files
omarchycn/README.md
T
Jitendra daraandGitHub 5c51ad6d54 Fix broken manual links in README (#6809)
* Fix README having broken links

Reordered and updated the list of manual sections in the README.

* Update README with new section ordering and links
2026-08-13 21:02:47 +02:00

80 lines
2.7 KiB
Markdown

# Omarchy
Omarchy is a beautiful, modern & opinionated Linux distribution by DHH.
Read more at [omarchy.org](https://omarchy.org).
## The Omarchy Manual
The manual lives in [`manual/`](manual/), which is its authoritative source. It's
mirrored to [learn.omacom.io](https://learn.omacom.io/2/the-omarchy-manual), where
its screenshots are also hosted.
- [Welcome to Omarchy!](manual/01-welcome-to-omarchy.md)
**The Basics**
- [Getting Started](manual/02-getting-started.md)
- [Navigation](manual/03-navigation.md)
- [The top bar](manual/04-the-top-bar.md)
- [Themes](manual/05-themes.md)
- [Hotkeys](manual/06-hotkeys.md)
- [Unified Clipboard & History](manual/07-unified-clipboard-history.md)
- [Reminders](manual/08-reminders.md)
- [Notices](manual/09-notices.md)
- [Text Extraction & Dictation](manual/10-text-extraction-dictation.md)
- [Screenshots & Recording](manual/11-screenshots-recording.md)
- [Toggles, idle & screensaver](manual/12-toggles-idle-screensaver.md)
- [Omarchy CLI](manual/13-omarchy-cli.md)
**The Applications**
- [Terminal](manual/14-terminal.md)
- [Neovim](manual/15-neovim.md)
- [AI](manual/16-ai.md)
- [Development Tools](manual/17-development-tools.md)
- [Shell Tools](manual/18-shell-tools.md)
- [Shell Functions](manual/19-shell-functions.md)
- [TUIs](manual/20-tuis.md)
- [GUIs](manual/21-guis.md)
- [Browsers](manual/22-browsers.md)
- [Commercial apps/services](manual/23-commercial-apps-services.md)
- [Web Apps](manual/24-web-apps.md)
- [Gaming](manual/25-gaming.md)
- [Filling out PDFs](manual/26-filling-out-pdfs.md)
- [Windows VM](manual/27-windows-vm.md)
- [Other Packages](manual/28-other-packages.md)
**Configuration**
- [Updates](manual/29-updates.md)
- [Dotfiles](manual/30-dotfiles.md)
- [Shell plugins](manual/31-shell-plugins.md)
- [Monitors](manual/32-monitors.md)
- [Keyboard, Mouse, Trackpad](manual/33-keyboard-mouse-trackpad.md)
- [Networking](manual/34-networking.md)
- [System sleep](manual/35-system-sleep.md)
- [Hardware authentication](manual/36-hardware-authentication.md)
- [Fonts](manual/37-fonts.md)
- [Backgrounds](manual/38-backgrounds.md)
- [Prompt](manual/39-prompt.md)
- [Branding](manual/40-branding.md)
- [Common tweaks](manual/41-common-tweaks.md)
- [Extra themes](manual/42-extra-themes.md)
- [Making your own theme](manual/43-making-your-own-theme.md)
**The Rest**
- [Mac support](manual/44-mac-support.md)
- [Troubleshooting](manual/45-troubleshooting.md)
- [FAQ](manual/46-faq.md)
- [System snapshots](manual/47-system-snapshots.md)
- [Security](manual/48-security.md)
- [Omarchy on...](manual/49-omarchy-on.md)
- [Dual Boot Install](manual/50-dual-boot-install.md)
- [Unattended Installs](manual/51-unattended-installs.md)
## License
Omarchy is released under the [MIT License](https://opensource.org/licenses/MIT).