Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #71

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Update README #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@ psh - which stands for Pascal's Shell is a configuration tool for zsh.
It is a composition of the finest plugins and a nice looking theme (currently it is one bundled with oh-my-zsh)
that helps myself and hopefully also others to grow their productivity by customizing their shell experience.

This installer enables the fast installation of zsh, zplug and other stuff that is required for a great zsh experience on the shell.
This installer enables the fast installation of zsh, zplug, oh-my-zsh and other plugins that provide a great zsh experience.
The installer generates always a custom .zshrc which can be modified by adding own customizations to the plugins folder.
To make customizations even easier, psh has a template system that allows the import of personalized .zshrc snippets that are composed together
and inserted into the generated configuration!

It was never that easy and therefore fast to install a customized shell than with psh - and with some knowledge about shell scripting with bash,
It was never that easy and therefore fast to install a customized shell than with psh - and with some knowledge about shell scripting with bash/zsh,
you will be able to implement everything you could imagine in a configuration for zsh.

> Why psh if I could just use zplug?
>
> First of all, psh is pre-configured in a way that is already quite powerful.
> Firstly, psh is pre-configured in a way that is already quite powerful.
> The target of the default configuration is to make shell enjoyable and move people
> to prefer shell over GUI.
>
> Secondly, psh takes care of dependencies. You setup your new os, clone this repository
> and run the `install.sh` script. If your system is supported, psh installs literally
> everything necessary - from zsh to git or curl - you can just start working without
> any further manual stuff to do for your shell setup.
> and run the `install.sh` script. If your system is supported, psh installs
> everything necessary - from zsh to git or curl.
> After the install script, your zsh is ready to go.

![PSH Installer](https://github.com/pascal-zarrad/psh/raw/master/.github/MEDIA/psh.gif)

Expand All @@ -30,18 +33,19 @@ The targets of psh are:
You can find a list of used frameworks and plugins in the wiki under [Technologies](https://github.com/pascal-zarrad/psh/wiki/Technologies).

## Compatibility
In theory all configuration done by psh should work on any system that is compatible with zsh and all dependencies that are used to enhance the zsh experience.
But as the installer uses ```apt```, you need any system that supports ```apt``` to use it.
In theory all configuration done by psh should work on any system that is compatible with zsh and all dependencies
that are used to enhance the zsh experience. However, due to package management, not all operating systems are supported.

Currently psh is only tested in the following environments:
* Arch Linux
* Manjaro Linux
+ Windows Subsystem for Linux 2 (WSL2)
* Ubuntu
* Debian
+ PopOs!
* PopOs!
* Windows Subsystem for Linux 2 (WSL2)

Always assume that the newest operating system version relativ to the newest release has been used.
psh is is only tested on the current OS releases when a release is made.
If you want to be sure, test psh in a virtual machine before installing it.

You can find further information in the wiki under [Compatibility](https://github.com/pascal-zarrad/psh/wiki/Compatibility).

Expand All @@ -50,7 +54,7 @@ You can find further information in the wiki under [Compatibility](https://githu
The installation is documented in the wiki under [Installation](https://github.com/pascal-zarrad/psh/wiki/Installation).

## Updating
Updating psh is as simple as installing it- you just need to pull the newest version from GitHub.
Updating psh is as simple as installing it - you just need to pull the newest version from GitHub.
You find information on how to update psh in the wiki under [Updating](https://github.com/pascal-zarrad/psh/wiki/Updating).

## Creating templates
Expand Down