Skip to content

Commit 08bdb3e

Browse files
committed
Update README with detailed plugin info and features
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.
1 parent 6727e18 commit 08bdb3e

File tree

1 file changed

+43
-14
lines changed

1 file changed

+43
-14
lines changed

README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,59 @@
1-
# prettify-python-plugin
1+
# Prettify Python Plugin
2+
23
[![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/r/stars/12017?label=JetBrans%20Marketplace)](https://plugins.jetbrains.com/plugin/12017)
34
[![JetBrains IntelliJ plugins](https://img.shields.io/jetbrains/plugin/d/12017)](https://plugins.jetbrains.com/plugin/12017)
45
[![Twitter Follow](https://img.shields.io/twitter/follow/meanmaildev?style=plastic)](https://twitter.com/meanmaildev)
56

6-
Intellij IDE plugin
7+
Enhance the readability of your Python code with beautiful mathematical symbols! This IntelliJ plugin automatically replaces standard Python operators with their mathematical equivalents.
8+
9+
## Features
10+
11+
- **Automatic Operator Replacement**: Convert standard Python operators to mathematical symbols
12+
- **Customizable Rules**: Configure replacement patterns to match your preferences
13+
- **Instant Application**: See changes immediately as you type
14+
- **IDE Integration**: Seamlessly works within your IntelliJ environment
15+
16+
## Supported Replacements
17+
18+
| Python Operator | Mathematical Symbol | Description |
19+
|----------------|---------------------|-------------|
20+
| >= || Greater than or equal |
21+
| <= || Less than or equal |
22+
| != || Not equal |
23+
| -> || Arrow |
24+
| lambda | λ | Lambda |
25+
| ** | ^ | Power |
26+
27+
## Installation
728

8-
https://meanmail.dev/plugin/2
29+
1. Open IntelliJ IDE
30+
2. Go to Settings/Preferences → Plugins
31+
3. Search for "Prettify Python"
32+
4. Click Install
33+
5. Restart IDE if required
934

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

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

14-
All product with python 2019.2—2020.3(eap)
41+
## Supported IDE Versions
1542

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

18-
### Folding
45+
## Support and Feedback
1946

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

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

24-
!= to ≠
53+
## License
2554

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

28-
lambda to λ
57+
---
2958

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

0 commit comments

Comments
 (0)