Skip to content

Commit

Permalink
Update README with detailed plugin info and features
Browse files Browse the repository at this point in the history
Expanded the README to include comprehensive details about the plugin's features, installation steps, supported replacements, and configuration options. Improved clarity and structure to enhance usability and understanding for users.
  • Loading branch information
meanmail committed Dec 17, 2024
1 parent 6727e18 commit 08bdb3e
Showing 1 changed file with 43 additions and 14 deletions.
57 changes: 43 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,59 @@
# prettify-python-plugin
# Prettify Python Plugin

[![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/r/stars/12017?label=JetBrans%20Marketplace)](https://plugins.jetbrains.com/plugin/12017)
[![JetBrains IntelliJ plugins](https://img.shields.io/jetbrains/plugin/d/12017)](https://plugins.jetbrains.com/plugin/12017)
[![Twitter Follow](https://img.shields.io/twitter/follow/meanmaildev?style=plastic)](https://twitter.com/meanmaildev)

Intellij IDE plugin
Enhance the readability of your Python code with beautiful mathematical symbols! This IntelliJ plugin automatically replaces standard Python operators with their mathematical equivalents.

## Features

- **Automatic Operator Replacement**: Convert standard Python operators to mathematical symbols
- **Customizable Rules**: Configure replacement patterns to match your preferences
- **Instant Application**: See changes immediately as you type
- **IDE Integration**: Seamlessly works within your IntelliJ environment

## Supported Replacements

| Python Operator | Mathematical Symbol | Description |
|----------------|---------------------|-------------|
| >= || Greater than or equal |
| <= || Less than or equal |
| != || Not equal |
| -> || Arrow |
| lambda | λ | Lambda |
| ** | ^ | Power |

## Installation

https://meanmail.dev/plugin/2
1. Open IntelliJ IDE
2. Go to Settings/Preferences → Plugins
3. Search for "Prettify Python"
4. Click Install
5. Restart IDE if required

Your ratings and feedback are very important. The feature will appear the faster the more people request it.
## Configuration

## Supported versions of Intellij:
1. Go to Settings/Preferences
2. Navigate to "Prettify Python" in the plugins list
3. Customize replacement rules according to your preferences

All product with python 2019.2—2020.3(eap)
## Supported IDE Versions

## Features:
Compatible with all IntelliJ-based IDEs that support Python, version 2024.3 and above.

### Folding
## Support and Feedback

\>= to ≥
- Plugin Page: [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/12017)
- Website: [meanmail.dev/plugin/2](https://meanmail.dev/plugin/2)
- Twitter: [@meanmaildev](https://twitter.com/meanmaildev)

<= to ≤
Your ratings and feedback are very important! New features are prioritized based on user requests.

!= to ≠
## License

-> to ➔
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

lambda to λ
---

** to ^
Made with ❤️ by [meanmail.dev](https://meanmail.dev)

0 comments on commit 08bdb3e

Please sign in to comment.