Commit graph

66 commits

Author SHA1 Message Date
Jim f5a8cb456b Removing fig from README.md
Fig is sunsetting as per https://fig.io/blog/post/fig-is-sunsetting
2024-04-15 21:36:51 -05:00
Indrajit Raychaudhuri ac356c8cf6
Adjust instruction for setting custom $ZDOTDIR
Adjust instruction for setting custom `$ZDOTDIR`.

This addresses 2 potential issues:
- Check for the presence of `$XDG_CONFIG_HOME/zsh` before assigning it to `$ZDOTDIR` instead of blindly assigning
- Avoid recursion in zsh variable assignment stack that might occasionally result in messages like:
```
zsh: job table full or recursion limit exceeded
```
2024-01-18 19:13:22 -06:00
Ilkin Bayramli b2bc66ce9d
Add Fig as an installation method to the README 2022-06-15 10:42:21 -07:00
Andrew Kvalheim 7f8b9b829a general: Correct typo in installation instructions
Resolves “zsh: bad substitution”
2021-11-12 08:31:37 -08:00
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00
Indrajit Raychaudhuri be61026920 general: Apply submodules' path change in doc and zprezto-update
We need to accommodate cases where a submodule local path (or remote)
URL can change. Accordingly, update instruction and `zprezto-update`
function to synchronizes submodules' remote URL configuration setting
to the updated value automatically.
2021-05-05 14:13:01 -05:00
Indrajit Raychaudhuri d80e393f78 general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should
also make markdown linting happier.

Prefer back-ticks wherever useful and use `console` for code blocks to
be executed on terminal.

Also, update references links wherever possible (including update from
'http://' to 'https://').
2021-05-05 12:21:04 -05:00
kwgchi cb8b9ca746
README: fix small grammatical error (#1857) 2020-07-20 16:08:54 -07:00
Indrajit Raychaudhuri df4c61861d doc: Bit of copyediting and formatting for consistency and clarification 2018-10-11 17:10:38 -05:00
Bruce Clounie 7bb7a7cb6f Add explanation for extra git theme symbols in README.md
Helps with #1589
2018-08-13 14:14:19 -05:00
Tharre 152b4a1b5d Fix broken gitref link in README.md
gitref.org points to services.github.com, and has been for some time[0].

[0] https://github.com/git/git-reference/issues/112
2018-08-01 13:47:22 -04:00
Kaleb Elwert a3f40a7479 Fix README formatting 2017-11-12 17:54:49 -08:00
Kaleb Elwert d725233bb1 Add basic documentation on external module directories 2017-11-12 17:53:10 -08:00
Parth Laxmikant Kolekar b5d09e2da7 Lower requirements down to 4.3.11 again (#1491)
There was an update with the syntax-highlighting module which fixed compatibility with 4.3.11.
2017-10-20 10:38:48 -07:00
Jeff Widman 0fc49ac4f0 Fix typos 2017-07-25 03:07:59 -06:00
Indrajit Raychaudhuri 24b710f545 [general] Fix incorrect fenced code indentation 2017-07-22 13:57:43 -05:00
Indrajit Raychaudhuri ac628c9059 [general] Switch code block formatting to use fence formatting
Changes:
* Indented code block doesn't support syntax highlighting, use fenced
formatting (```) instead for better syntax highlighting
* Wrap commands/functions in backticks
* Typo fixes
2017-07-22 13:11:29 -05:00
Samantha McVey 87868441eb [zprezto-update] Add convenience function to update zprezto (#1344)
* [zprezto-update] Add convenience function to update zprezto

This function checks if there is any update to zprezto, and if so
will pull in the changes. It will not attempt a pull unless
it is fastforwardable. It also makes sure the user is on the master
branch before attempting.

* [zprezto-update] Improve resilience of the function

Better error checking of status of the git repository
and better error producing.

Fit columns into mostly 80 width and add a missing printf
argument.

Use ( ) around the function so changing directory does not affect
the outer scope.

* [README] Add instructions on using zprezto-update function
2017-06-29 23:26:53 -07:00
Kaleb Elwert d035e4cf1e Fix indentation in README 2017-04-13 03:27:59 -07:00
Kaleb Elwert 2e20eb8571 Add note about working around preexisting runcoms
Closes #955
2017-04-13 02:53:07 -07:00
Paul Melnikow 909006638d Bump license years and tidy up readme (#1273) 2017-04-05 09:34:31 -07:00
Mateusz Lewko 5271af8180 Ensure code blocks are formatted properly for GitHub (#1271) 2017-04-03 13:29:58 -07:00
Sorin Ionescu fe64f91f52 Update sorin screenshot 2015-05-19 18:25:40 -04:00
Sorin Ionescu c34098af20 Update copyright 2015-03-08 23:38:06 -04:00
Sorin Ionescu 087fce8548 Update sorin theme screenshot 2014-11-11 20:51:45 -05:00
Sorin Ionescu a84ac5b002 Only one newline at end of file 2014-10-09 23:38:15 -04:00
Sorin Ionescu 06cc5088aa [Fix #630] Zsh v4.3.17 is the minimum required 2014-10-05 21:12:42 -04:00
Chauncey Garrett 5088ca4839 Bump minimum supported Zsh to v4.3.11
zsh-syntax-highlighting requires this version.

Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-10-05 20:25:25 -04:00
Sorin Ionescu 391bc405d0 Revert "Warn that Cygwin is not supported"
This reverts commit b1abe7a845.
2014-01-04 17:30:38 -05:00
Julien Stechele aefdce3fc3 Fix README.md: PATH was moved from .zshenv to .zprofile 2014-01-03 13:41:05 -05:00
Sorin Ionescu 347928193f Update copyright 2013-12-08 01:34:27 -05:00
Sorin Ionescu a57d545639 Update copyright 2013-11-29 19:13:06 -05:00
Sorin Ionescu b1abe7a845 Warn that Cygwin is not supported 2013-11-29 08:46:14 -05:00
Sorin Ionescu 8993a8dfad Bump minimum supported Zsh to v4.3.11 2013-11-20 09:59:02 -05:00
Sorin Ionescu aacff80984 [Fix #477] Add instructions for updating Prezto 2013-09-26 14:08:44 -04:00
Phillip Alexander 92c4dc0fb2 Clarify customization instructions
Explicitly state that a new user must create his own fork to commit and
track changes via Github.

Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2013-08-12 18:27:50 -04:00
Sorin Ionescu 6fd00449a6 [Fix #381] Remove the path_helper workaround 2013-01-28 18:06:14 -05:00
Sorin Ionescu bc8533c30e Update sorin theme screenshot 2012-09-25 17:25:29 -04:00
Sorin Ionescu 2037e693e8 [Fix #293] Add CONTRIBUTING.md 2012-09-25 13:17:16 -04:00
Sorin Ionescu ab0eedd45e Update sorin theme screenshot 2012-09-09 20:06:12 -04:00
dnuux 491ac265ca Fix typos in README 2012-09-06 23:37:28 -04:00
Sorin Ionescu cc7e43b242 [Fix #253] Move Prezto settings into their own file 2012-09-03 16:52:47 -04:00
Sorin Ionescu d041e44cfe [Fix #255] Symlink rc files 2012-09-03 16:51:32 -04:00
Sorin Ionescu fb9a20591f [Fix #197] Rebrand as Prezto
Conflicts:
	README.md
	runcoms/zshenv
2012-09-03 16:51:27 -04:00
Sorin Ionescu d9f2b36a34 Alter installation per repository rename 2012-08-28 23:57:59 -04:00
Sorin Ionescu 8e7589d56a Link zsh-lovers in the main README 2012-08-27 20:17:36 -04:00
Sorin Ionescu 4747b72efc Do not discuss zsh-completions in the main README 2012-08-27 19:19:45 -04:00
Sorin Ionescu df82640caa Rename templates to runcoms 2012-08-04 14:55:38 -04:00
Suraj N. Kurapati a2f9168671 Simplify installation instructions 2012-07-03 19:11:53 -04:00
Sorin Ionescu 859ab4e8e0 Correct spelling mistakes in READMEs 2012-06-12 15:13:21 -04:00