From d67eaf498c5947a7e26f13c40e4fdc4831e7748b Mon Sep 17 00:00:00 2001 From: Helge Sverre Date: Thu, 17 Aug 2023 15:05:43 +0200 Subject: [PATCH] add troubleshooting step about composer vendor/bin paths in readme --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 903dfc7..c4100a8 100644 --- a/README.md +++ b/README.md @@ -445,7 +445,7 @@ composer build - what body format to use by default or fallback on - ignored parameters, - how to handle Pagination - - if JSON bodies with null values should be removed + - if JSON bodies with null values should be removed - If you want resource classes or not - failure handling (AlwaysThrowOnErrors, custom exception classes, or [custom method](https://docs.saloon.dev/the-basics/handling-failures#customising-when-saloon-thinks-a-request-has-failed)) @@ -485,6 +485,34 @@ With a comprehensive suite of features such as day sheets, checklists, reporting simplifies event management. Professionals in the live event industry trust Crescat to streamline their workflows, reducing the need for multiple tools and outdated spreadsheets. +## Troubleshooting: + +### Fixing `command not found` errors + +You most likely don't have the composer `vendor/bin` folder in your `$PATH` + +```shell +# Default config file paths +# Zsh: ~/.zshrc +# Bash: ~/.bashrc or ~/.bash_profile +# Fish: ~/.config/fish/config.fish + +# Replace 'YOUR_USERNAME' with your actual username +# Example: '/Users/john/.composer/vendor/bin' + +# Zsh +echo 'export PATH="/Users/YOUR_USERNAME/.composer/vendor/bin:$PATH"' >> ~/.zshrc +source ~/.zshrc + +# Bash +echo 'export PATH="/Users/YOUR_USERNAME/.composer/vendor/bin:$PATH"' >> ~/.bashrc +source ~/.bashrc + +# Fish +echo 'set -gx PATH "/Users/YOUR_USERNAME/.composer/vendor/bin" $PATH' >> ~/.config/fish/config.fish +source ~/.config/fish/config.fish +``` + ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.