Skip to content

Commit

Permalink
style(core): format files using prettier (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
luismayta committed Nov 10, 2024
1 parent aac4e4c commit 4c098cc
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 71 deletions.
128 changes: 58 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,90 +3,111 @@
** DO NOT EDIT THIS FILE
**
** 1) Make all changes to `README.yaml`
** 2) Run`make readme` to rebuild this file.
** 1) Make all changes to `provision/generator/README.yaml`
** 2) Run`task readme` to rebuild this file.
**
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
**
-->






[![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-rvm)](https://github.com/hadenlabs/zsh-rvm/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/zsh-rvm/lint-code)](https://github.com/hadenlabs/zsh-rvm/actions?workflow=lint-code) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com)
[![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-rvm)](https://github.com/hadenlabs/zsh-rvm/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/zsh-rvm/lint-code)](https://github.com/hadenlabs/zsh-rvm/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/zsh-rvm/ci)](https://github.com/hadenlabs/zsh-rvm/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/zsh-rvm/test)](https://github.com/hadenlabs/zsh-rvm/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)

# zsh-rvm

zsh-rvm plugin for zsh.











zsh-rvm for project

## Requirements


This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

* [zsh-core](https://github.com/hadenlabs/zsh-core)
- [zsh-rvm](https://github.com/hadenlabs/zsh-rvm)
- [gomplate](https://github.com/hairyhenderson/gomplate)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Installation

<!-- Space: Projects -->
<!-- Parent: ZshRvm -->
<!-- Title: Installation Oh-My-Zsh ZshRvm -->
<!-- Label: ZshRvm -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Label: Oh-My-Zsh -->
<!-- Include: docs/disclaimer.md -->
<!-- Include: ac:toc -->

## Installation
### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users
### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) users

If you're using [oh-my-zsh](https://gitub.com/robbyrussell/oh-my-zsh), install this plugin by doing the following:
If you're using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), install this plugin by doing the following:

1. Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`
2. Clone the plugin `bash git clone https://github.com/hadenlabs/zsh-rvm`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-rvm )` to your list of plugins
4. Open a new terminal and enjoy!
<!-- Space: Projects -->
<!-- Parent: ZshRvm -->
<!-- Title: Installation Antigen ZshRvm -->
<!-- Label: ZshRvm -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Label: Antigen -->
<!-- Include: docs/disclaimer.md -->
<!-- Include: ac:toc -->

### [antigen](https://github.com/zsh-users/antigen) users

If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:

1. Add `antigen bundle hadenlabs/zsh-rvm` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle hadenlabs/zsh-rvm` in a running zsh session.
3. Enjoy!
<!-- Space: Projects -->
<!-- Parent: ZshRvm -->
<!-- Title: Installation Antibody ZshRvm -->
<!-- Label: ZshRvm -->
<!-- Label: Project -->
<!-- Label: Installation -->
<!-- Include: docs/disclaimer.md -->
<!-- Include: ac:toc -->

### [antibody](https://github.com/getantibody/antibody) users

If you're using [Antibody](https://github.com/getantibody/antibody), install this plugin by doing the following:

1. Add :
1. Add :

```{.sourceCode .bash}
antibody bundle hadenlabs/zsh-rvm
antibody bundle hadenlabs/zsh-rvm
```

to your `.zshrc` where you're adding your other plugins.

2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle hadenlabs/zsh-rvm` in a running zsh session.
3. Enjoy!




## Usage

# How to use this project

```bash
task setup
```

## Examples

<!-- Space: Projects -->
<!-- Parent: ZshRvm -->
<!-- Title: Examples ZshRvm -->
<!-- Label: Examples -->
<!-- Include: ./../disclaimer.md -->
<!-- Include: ac:toc -->

### Common



## Functions
## Functions

zsh rvm includes a small utility `rvm` to fetch and install new packages.

Expand Down Expand Up @@ -114,11 +135,6 @@ Install versions of config for rvm.

Install a version global of rvm.






## Help

**Got a question?**
Expand All @@ -127,21 +143,7 @@ File a GitHub [issue](https://github.com/hadenlabs/zsh-rvm/issues).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/hadenlabs/zsh-rvm/issues) to report any bugs or file feature requests.

### Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!
See [Contributing](./docs/contributing.md).

## Module Versioning

Expand All @@ -155,35 +157,21 @@ Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following co

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is
increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is
increased. (Pre-release)



- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)


Copyright © 2018-2024 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.






## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).



## Don't forget to 🌟 Star 🌟 the repo if you like zsh-rvm

[Your feedback is appreciated](https://github.com/hadenlabs/zsh-rvm/issues)
2 changes: 1 addition & 1 deletion provision/generators/README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ email:
#logo: docs/logo.png

# License of this project
license: 'LGPL-3.0'
license: "LGPL-3.0"

# Canonical GitHub repo
github_repo: hadenlabs/zsh-rvm
Expand Down

0 comments on commit 4c098cc

Please sign in to comment.