diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fdc1028..fe5f294 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -30,3 +30,5 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. + +![blah](/resources/images/Extensible.png) diff --git a/.github/workflows/CI.yaml b/.github/workflows/CI.yaml index 852d02d..b3f61c3 100644 --- a/.github/workflows/CI.yaml +++ b/.github/workflows/CI.yaml @@ -17,7 +17,7 @@ jobs: - name: Install dependencies shell: bash run: > - sudo apt-get install -y + sudo apt-get install -y fish git curl python3 python3-venv diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebe862b..8f19451 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,23 +2,9 @@ 🌊 Thank you for contributing to Tide! 🌊 -## Installing for Developers - -The `tide_install` function offers a few flags. `-d` will install Tide as a developer which provides extra files for testing. `-l` will install Tide from a local directory. When installing remotely, `tide_install` takes a branch name as an argument, defaulting to master. - -Examples: - -```console -tide_install -d example-branch -``` - -```console -tide_install -ld ~/tide -``` - ## Testing -The `tide test` command runs tests from the `$_tide_dir/tests` folder using [fishtape][]. Currently there are unit tests for most prompt items. +The `tide test` command runs tests from the `$_tide_dir/tests` folder using [fishtape][]. Currently there are unit tests for most prompt items. You can quickly install fisher and fishtape using `tide test -i` Example: @@ -26,6 +12,12 @@ Example: tide test status ``` +You can run all tests with the `-a` flag. + +```console +tide test -a +``` + ## Git Workflow 1. Fork this repository diff --git a/README.md b/README.md index ab667e4..2164092 100644 --- a/README.md +++ b/README.md @@ -179,20 +179,20 @@ Open each file and click "Install". This will make the `Sauce Code Pro` font ava [ci]: https://github.com/IlanCosman/tide/actions?query=workflow%3ACI [ci_badge]: https://github.com/IlanCosman/tide/workflows/CI/badge.svg -[configuration_wizard]: ./resources/svgs/Configuration_Wizard.svg +[configuration_wizard]: /resources/svgs/Configuration_Wizard.svg [contributing guide]: https://github.com/IlanCosman/tide/blob/master/CONTRIBUTING.md -[extensible]: ./resources/images/Extensible.png +[extensible]: /resources/images/Extensible.png [fish]: https://github.com/fish-shell/fish-shell [fish_git_prompt]: https://fishshell.com/docs/current/cmds/fish_git_prompt.html [fish_version_badge]: https://img.shields.io/badge/fish-3.1.0%2B-blue [git]: https://github.com/git/git -[license]: ./LICENSE.md +[license]: /LICENSE.md [license_badge]: https://img.shields.io/github/license/IlanCosman/tide -[multi-line_right_prompt]: ./resources/images/Multi-Line_Right_Prompt.png +[multi-line_right_prompt]: /resources/images/Multi-Line_Right_Prompt.png [powerlevel10k]: https://github.com/romkatv/powerlevel10k/ -[prompt_connection]: ./resources/images/Prompt_Connection.png +[prompt_connection]: /resources/images/Prompt_Connection.png [pure]: https://github.com/rafaelrinaldi/pure -[pure_compatibility]: ./resources/svgs/Pure_Compatibility.svg +[pure_compatibility]: /resources/svgs/Pure_Compatibility.svg [releases]: https://github.com/IlanCosman/tide/releases [release_badge]: https://img.shields.io/github/v/release/IlanCosman/tide?label=%20 [sauce code pro bold.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold/complete/Sauce%20Code%20Pro%20Bold%20Nerd%20Font%20Complete.ttf