gib/sunhat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Expanded

Browse Source
This commit is contained in:
David Heinemeier Hansson 2024-06-04 16:05:16 -07:00
parent 14baed6996
commit 8dc64c107a
1 changed files with 41 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -1,12 +1,14 @@
# Omakub # Omakub
Turn a default Ubuntu installation into a fully-configured, beautiful, and modern development experience. No need to write bespoke configs for every essential tool just to get started or to be up on all the latest command-line tools. Omakub is an opinionated take on what Linux can be at its best. Turn a default Ubuntu installation into a fully-configured, beautiful, and modern web development experience. No need to write bespoke configs for every essential tool just to get started or to be up on all the latest command-line tools. Omakub is an opinionated take on what Linux can be at its best.
This includes curating a set of applications and tools that one might discover through hours of watching YouTube, reading blogs, or just stumbling around Linux internet. All in service of someone coming straight from a platform like Windows or the Mac who shouldn't have to do all the configuration and curation legwork to see what all the fuss is about. This includes curating a set of applications and tools that one might discover through hours of watching YouTube, reading blogs, or just stumbling around Linux internet. All in service of someone coming straight from a platform like Windows or the Mac, who shouldn't have to do all the configuration and curation legwork to see what all the fuss is about.
This isn't a tool for someone already versed in the intricasies of nixOS or relishing a fresh install of Arch.
## Installers ## Installers
Ubuntu has a great pair of package managers in apt and snap, but many of the tools that developers want either haven't been packaged, need more recent versions than what has been frozen in the LTS, or need actions post-install necessary for the best operation. These instructions are encoded in scripts present in install/*.sh. Ubuntu has a great package manager in apt, but many of the tools that developers want either haven't been packaged, need more recent versions than what has been frozen in the LTS, or need actions post-install necessary for the best operation. These instructions are encoded in scripts present in install/*.sh.
## Dotfiles ## Dotfiles
@ -18,32 +20,46 @@ Nothing in Omakub provides solutions to problems you couldn't also solve a milli
This doesn't make the choices necessarily better than other choices. Linux has inspired a million options for a million tastes. That's great and worthy of celebration. This doesn't make the choices necessarily better than other choices. Linux has inspired a million options for a million tastes. That's great and worthy of celebration.
But there's a large constituency of developers who are more than willing to trade ultimate bespoke customization for a cohesive package of goods. But there's a large constituency of developers who are more than willing to trade ultimate bespoke customization for a cohesive package of goods, at least until they understand what all the options are and have fully bought into making the switch to Linux.
## What's on the menu ## What's on the menu
### Alacritty Omakub contains a mix of open source and commercial software. This isn't meant as a Free Software banner, but as a mixtape for working web developers who might begrudge Google, but still want to use the same Chrome browser that the majority of regular web users do. So you'll find that browser as the default (Firefox is still there too), Spotify is installed by default, as is Zoom, and even 1password. Don't worry, you can just remove (or ignore) anything you don't need or want.
### Zellij
### Neovim w/ Lazyvim But the heart of the pre-configuration lies in the terminal, Alacritty, which runs Zellij to provide multiple panes/sessions. It's still bash underneath, but one configured with a host of great file system tools, like eza, fzf, rg, zoxide, and bg. Don't worry if you don't know what any of those things are! Watch the introduction video, and you'll see it all in action.
### VSCode
### Tactile Then comes the editor. As much as I love neovim now, it's not for everyone, so by default Omakub comes with both Neovim (configured via lazyvim) and Microsoft's VSCode. There are plenty of other choices, but these two are the ones that have been integrated into the unified theme picking (we'll get to that in a moment).
### Ulauncher
### Lazygit + Lazydocker The overall UI of Ubuntu is of course Gnome, but it's been tweaked substantially to cater to a keyboard-first and window-tiling workflow. You shouldn't be moving windows around with a mouse like a savage when using this setup! Use the six default workspaces for apps (hotkeys: Super + 1/2/3/...), preferably full-screen ones on laptop displays, or tiled neatly using Tactile (hotkey: Super + T). Speed of motion is also why all the transition animations have nerfed. And start any app in the dock (hotkey: Super) based on it's position (hotkey: Alt + 1/2/3/4). So browser is just Alt+1, Terminal Alt+2, etc.
### eza/fzf/bat/rg/zoxide
### Fonts Additionally, ulauncher provides an app launcher ala raycast, which you trigger with Super+Space. And you can quickly enter emojis with the compose key (which is mapped to Caps Lock) m and then a single letter representing the emoji. Run omakub, pick hotkeys, and there you can see it all.
### Typora
### Google Chrome ## What's the dress code
### Docker
### Ruby + Node By default, Omakub ships with a Tokyo Night theme that looks ace with everything. But after installation, you can run the omakub command, select theme, and pick from one of the other handful of curated and fully integrated themes. Picking a new theme will set colors for the terminal (Alacritty + Zellij) and the editor (both VSCode and Neovim), as well as set a matching background image and Gnome UI accent color. It's pretty sweet!
### Virtualbox
### Spotify/Zoom/1password The font is Microsoft's beautiful Cascadia Mono, patched by Nerd Fonts. But also here there's a curated selection of alernatives. Run omakub, select font, and pick one of the options. It'll be set in terminal and editor automatically as well.
### VLC/Signal/Pinta/Xournal
### Libraries and build tooling A handful of Gnome Extensions provide some additional sizzle with blurring of the shell, hiding desktop icons (so you can enjoy those background images!), and a handful of other tweaks. Run the Gnome Extensions Manager (try Super+Space extensions to open it with ulauncher).
### Theme
## What else
Omakub also installs...
- WhatsApp + Signal for messaging
- Xournal for filling out and signing PDF forms
- Flameshot for more powerful screenshotting (hotkey: Ctrl + Print Screen)
- VLC for playing videos
- Pinta for quick image editing
- The gh command for GitHub's CLI
- Docker, with preconfigured containers for MySQL + Redis, and gives you the super cool TUI lazydocker to start/stop them.
- rbenv and nodenv, as well as the recent versions for both, for managing multiple versions of each on the same system.
- A fix for the Framework 13's first generation display so fonts look proportional.
## Origin and context ## Origin and context
Omakub was started by David Heinemeier Hansson to streamling his own Linux box boostrapping, as well as that of his employees at 37signals switching to Linux. That's very much a specific context where Ruby on Rails, web development tooling, and commercial services all intermingle. There's amble room to broaden that context to provide the same benefits to many other web developer communities, similarly dominated by a Mac bias. But that expansion will be carefully managed to stay with The Omakase Spirit. Rather install a few more tools than litter the project with endless configuration points. In the end, every tool preconfigured can be postconfigured in a different direction. Omakub was started by me, David Heinemeier Hansson, to streamling my own Linux box boostrapping, as well [helping our technical employees at 37signals switch to Linux](https://world.hey.com/dhh/linux-as-the-new-developer-default-at-37signals-ef0823b7). That's very much a specific context where Ruby on Rails, web development tooling, and commercial services all intermingle. There's amble room to broaden that context to provide the same benefits to many other web developer communities (many of which are also dominated by a Mac bias). But that expansion will be carefully managed to stay with The Omakase Spirit. Rather install a few more tools than litter the project with endless configuration points. In the end, every tool preconfigured can be postconfigured in a different direction.
## Future ideas ## Future ideas
@ -51,12 +67,6 @@ Omakub is being born as a single, curated setup for one specific company in one
But anyone using Omakub should still just have to run 1 command and the result should be 1 specific setup. But anyone using Omakub should still just have to run 1 command and the result should be 1 specific setup.
## FAQ ### Acknowledgements
### Why not just use nixOS? Default Tokyo Night and Rose Pine desktop backgrounds were designed by [freepik](https://freepik.com).
Ubuntu is the most popular mainstream Linux distribution. It's available out-of-the-box from major manufacturers. It's learning curve is low, it's polished, it's stable, and if you hit problems, you'll easily find others online with the same issue. That doesn't mean it's The Best. Nobody is ever going to convince all existing Linux users that their distro of choice isn't actually better. And some, like nixOS, have been specifically designed for some of the same preconfiguration ideas that we're exploring here. But it just doesn't matter. This is a project for tailoring Ubuntu (and derivatives built on it and similar base elements).
## Acknowledgements
Default 80s Palm Tree desktop background was designed by freepik.