Skip to content

rgazeredo/p10k-theme-generator

Repository files navigation

Below is the updated README in English with the "Getting Started" section removed and a quick guide on how to contribute added:


p10k-theme-generator

p10k-theme-generator is an open source tool for generating customized themes for Powerlevel10k. Currently, the project offers a set of color configurations, but Powerlevel10k provides many additional customization options to explore.

Features

  • Customizable Colors: Easily adjust color schemes to match your style.
  • Simple Interface: Use an intuitive web interface to generate your configuration.
  • Open Source: Maintained by the community and open to contributions.
  • Powerlevel10k Compatible: Designed specifically for seamless integration with Powerlevel10k.

Live Demo

Experience the generator live at: p10k-theme-generator.vercel.app

Usage

  1. Access the live demo or run the project locally.
  2. Customize your color options using the provided interface.
  3. Copy the generated configuration.
  4. Apply it to your Powerlevel10k configuration to update your theme.

How to Contribute

We welcome contributions from the community! To help improve p10k-theme-generator, please follow these simple steps:

  1. Fork the Repository: Click on the "Fork" button on GitHub to create your own copy.
  2. Clone Your Fork: Clone the repository to your local machine.
    git clone https://github.com/your-username/p10k-theme-generator.git
  3. Create a Branch: Create a new branch for your feature or fix.
    git checkout -b feature/your-feature-name
  4. Implement Your Changes: Make your improvements or add new features.
  5. Test Your Changes: Ensure that your contributions work as expected.
  6. Submit a Pull Request: Push your branch and open a pull request. Please reference any related issues to help us understand your changes.
  7. Join the Discussion: If you have ideas or need help, feel free to open an issue or join our community discussions.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

Special thanks to the Powerlevel10k community for inspiring projects like this and for continuously enhancing the terminal experience for everyone.