https://github.com/marlonrichert/zsh-launchpad

🚀 Simple, educational dotfiles template to get started with Zsh and learn about its features
https://github.com/marlonrichert/zsh-launchpad

configuration configuration-files dotfiles dotfiles-zsh educational-project learning-by-doing shell templates zsh zsh-configuration zsh-template zshrc

Last synced: about 2 months ago
JSON representation

🚀 Simple, educational dotfiles template to get started with Zsh and learn about its features

• Host: GitHub
• URL: https://github.com/marlonrichert/zsh-launchpad
• Owner: marlonrichert
• License: mit
• Created: 2021-12-06T11:14:49.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-07T12:29:06.000Z (over 1 year ago)
• Last Synced: 2024-06-14T22:50:34.560Z (3 months ago)
• Topics: configuration, configuration-files, dotfiles, dotfiles-zsh, educational-project, learning-by-doing, shell, templates, zsh, zsh-configuration, zsh-template, zshrc
• Language: Shell
• Homepage:
• Size: 37.1 KB
• Stars: 169
• Watchers: 9
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - marlonrichert/zsh-launchpad - 🚀 Simple, educational dotfiles template to get started with Zsh and learn about its features (Shell)

README

        
# Z Shell Launchpad 🚀

A simple dotfiles template to kick-start/bootstrap your `zsh` config and start

learning how to get the most out of your shell.

Copy these files into your home dir and you're good to go!

## What is this? What are its goals?

* It’s a fully functional set of dotfiles that works out of the box. Its goal

  is to help you be productive with Zsh right off the bat.

* It’s a template for you to customize to your own liking. Its goal is to give

  you a solid basis for your own Zsh, but without filling in details that are

  outside the scope of Zsh itself.

* It’s an educational tool with lots of examples and lots of comments to help

  you understand what the heck is going on. Its goal is to be a springboard for

  you to start your journey into learning Zsh, with plenty of links pointing

  you to further reading.

However, this is _not_ a finished product or a fire-and-forget piece of

software with a fixed API. Rather, you’re supposed to read it through and learn

from it, then use the knowledge you’ve gained to tailor it to your own needs.

It is, however, opinionated. It gives you what _I_ think is a solid set of

sensible defaults and deliberately does not delve into topics that I think are

better solved by using good plugins.

## Who is this for? Is it right for me?

This template is for those who

* want to have a ready-made config so they can get started with Zsh right away

  _and_

* want to actually learn how to write Zsh code and make the most of Zsh’s many

  features.

There is currently no alternative for new Zsh users that solidly checks both of

these boxes. Oh-My-Zsh and other “frameworks” cater to those who strongly want

the former, but don't give you any of the latter. Zsh itself also fails in this

regard. On one end, its [new user

wizard](https://github.com/zsh-users/zsh/blob/master/Functions/Newuser/zsh-newuser-install)

_tries_ to give you the former, but, rather than give you decent defaults,

forces you to choose from a wide array of confusing options and leaves you with

a poorly-documented config full of magic values. On the other end, its [_An

Introduction to the Z

Shell_](https://zsh.sourceforge.io/Intro/intro_toc.html) _tries_ to give you

the latter, but rather than being hands-on, presents you with endless lists of

abstract examples without clear, practical uses and hasn't been updated since

1995.

There is clearly a gap in the offerings for new Zsh users. This template is for

those who occupy that niche.

However, it does assume you already know how to program. It’s not going to

teach you that.