build: generate readme info (#51)

luismayta · Jan 28, 2021 · 9383570 · 9383570
1 parent 4fec7b8
commit 9383570
Showing 1 changed file with 77 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,35 @@
+<!--
+
+
+  ** DO NOT EDIT THIS FILE
+  **
+  ** 1) Make all changes to `README.yaml`
+  ** 2) Run`make readme` to rebuild this file.
+  **
+  ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
+  **
+
+
+  -->
+
 # zsh-pyenv
 
-python install and tools for zsh
+[![Build Status](https://travis-ci.org/luismayta/zsh-pyenv.svg?branch=main)](https://travis-ci.org/luismayta/zsh-pyenv) [![Issues](https://img.shields.io/github/issues/luismayta/zsh-pyenv.svg)](https://github.com/luismayta/zsh-pyenv/issues) [![Latest Release](https://img.shields.io/github/release/luismayta/zsh-pyenv.svg)](https://travis-ci.org/luismayta/zsh-pyenv/releases)
+
+zsh-pyenv plugin for zsh.
 
-[![Build
-Status](https://travis-ci.org/luismayta/zsh-pyenv.svg)](https://travis-ci.org/luismayta/zsh-pyenv) [![GitHub
-issues](https://img.shields.io/github/issues/luismayta/zsh-pyenv.svg)](https://github.com/luismayta/zsh-pyenv/issues) [![GitHub
-license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](LICENSE)
+---
+
+This project is part of our comprehensive [hadenlabs](https://hadenlabs.com) plugins of zsh.
 
-## Features
+It's 100% Open Source and licensed under the [MIT](LICENSE).
 
-- Task
+## Requirements
 
-## Dependencies
+This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:
 
-```{.bash}
+```{.sourceCode .bash}
+https://github.com/luismayta/zsh-core
 https://github.com/luismayta/zsh-notify
 https://github.com/luismayta/zsh-functions
 ```
@@ -22,7 +38,7 @@ https://github.com/luismayta/zsh-functions
 
 ### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) 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://gitub.com/robbyrussell/oh-my-zsh), 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/luismayta/zsh-pyenv`bash
@@ -31,87 +47,93 @@ If you\'re using [oh-my-zsh](https://gitub.com/robbyrussell/oh-my-zsh), install
 
 ### [antigen](https://github.com/zsh-users/antigen) users
 
-If you\'re using [Antigen](https://github.com/zsh-lovers/antigen), install this plugin by doing the following:
+If you're using [Antigen](https://github.com/zsh-lovers/antigen), install this plugin by doing the following:
 
-1.  Add `antigen bundle luismayta/zsh-pyenv` to your `.zshrc` where you\'re adding your other plugins.
+1.  Add `antigen bundle luismayta/zsh-pyenv` 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 luismayta/zsh-pyenv` in a running zsh session.
 3.  Enjoy!
 
 ### [antibody](https://github.com/getantibody/antibody) users
 
-If you\'re using [Antigen](https://github.com/getantibody/antibody), install this plugin by doing the following:
+If you're using [Antigen](https://github.com/getantibody/antibody), install this plugin by doing the following:
 
 1.  Add :
 
-    > ```{.bash}
-    > antibody bundle luismayta/zsh-pyenv
-    > ```
-    >
-    > to your `.zshrc` where you\'re adding your other plugins.
+```{.sourceCode .bash}
+     antibody bundle luismayta/zsh-pyenv
+```
+
+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 luismayta/zsh-pyenv` in a running zsh session.
-
 3.  Enjoy!
 
-## Quick Start
+## Usage
 
-- Fork this repository
+```bash
+make setup
+```
 
-### Usage
+## Help
 
-- Install dependences
+**Got a question?**
 
-```{.bash}
-λ make setup
-```
+File a GitHub [issue](https://github.com/luismayta/zsh-pyenv/issues), send us an [email][email] or join our [Slack Community][slack].
 
-## Support
+## Contributing
 
-If you want to support this project, i only accept `IOTA` :p.
+### Bug Reports & Feature Requests
 
-```{.bash}
-Address: FTDCZELEMOQGL9MBWFZENJLFIZUBGMXLFVPRB9HTWYDYPTFKASJCEGJMSAXUWDQC9SJUDMZVIQKACQEEYPEUYLAMMD
-```
+Please use the [issue tracker](https://github.com/luismayta/zsh-pyenv/issues) to report any bugs or file feature requests.
 
-## Team
+### Developing
 
----
+If you are interested in being a contributor and want to get involved in developing this project or [help out](https://hadenlabs.com) with our other projects, we would love to hear from you! Shoot us an [email](mailto:support@hadenlabs.com).
 
-[![Luis
-  Mayta](https://github.com/luismayta.png?size=100)](https://github.com/luismayta)
+In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
-[Luis Mayta](https://github.com/luismayta)
+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!
+
+### Versioning
+
+Releases are managed using github release feature. We use \[Semantic Versioning\](<http://semver.org>) for all the releases. Every change made to the code base will be referred to in the release notes (except for cleanups and refactorings).
+
+## Copyright
+
+Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)
 
 ## License
 
-MIT
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## Changelog
+The MIT License (MIT)
 
-Please see [CHANGELOG](CHANGELOG.rst) for more information what has changed recently.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-## Contributing
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-Contributions are welcome!
+Source: <https://opensource.org/licenses/MIT>
 
-Review the [CONTRIBUTING](docs/source/CONTRIBUTING.rst) for details on how to:
+## Trademarks
 
-- Submit issues
-- Submit pull requests
+All other trademarks referenced herein are the property of their respective owners.
 
-## Contact Info
+## About
 
-Feel free to contact me to discuss any issues, questions, or comments.
+This project is maintained and funded by [Hadenlabs][https://hadenlabs.com]. Like it? Please let us know at <support@hadenlabs.com>
 
-- [Email](slovacus@gmail.com:target:%20mailto:slovacus@gmail.com)
-- [Twitter](https://twitter.com/slovacus)
-- [GitHub](https://github.com/luismayta)
-- [LinkedIn](https://pe.linkedin.com/in/luismayta)
-- [Website](https://luismayta.github.io)
-- [PGP](https://keybase.io/luismayta/pgp_keys.asc)
+### Contributors
 
-[![linkedin](http://www.linkedin.com/img/webpromo/btn_liprofile_blue_80x15.png)](https://pe.linkedin.com/in/luismayta) [![beacon](https://ga-beacon.appspot.com/UA-65019326-1/github.com/luismayta/zsh-pyenv/readme)](https://github.com/luismayta/zsh-pyenv) [![made](https://img.shields.io/badge/Made%20with-Zsh-1f425f.svg)](http://www.zsh.org)
+| [![Luis Mayta][luismayta_avatar]][luismayta_homepage]<br/>[Luis Mayta][luismayta_homepage] |
+| ------------------------------------------------------------------------------------------ |
 
-Made with :coffee: and :pizza: by [Luis Mayta](https://github.com/luismayta) and [hadenlabs](https://github.com/hadenlabs).
+[luismayta_homepage]: https://github.com/luismayta
+[luismayta_avatar]: https://github.com/luismayta.png?size=150