Skip to content

Commit e43b5e6

Browse files
authored
Merge pull request #1 from MangelRyujin/document-md
2 parents d7c327a + a018dd9 commit e43b5e6

File tree

1 file changed

+57
-7
lines changed

1 file changed

+57
-7
lines changed

README.md

Lines changed: 57 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,61 @@
1-
# Textual Tool for Creating Member Profiles for python.pe
1+
# 🐍 edit-python.pe
2+
## *Textual Tool for Creating Member Profiles for python.pe*
23

3-
To run this tool, just type:
44

5-
```sh
6-
uvx edit-python-pe
5+
6+
## **QUICK START**
7+
8+
> **🔥 Welcome to the future!** This tutorial will guide you step-by-step to create your profile on python.pe quickly and securely.
9+
10+
### 🔧 **PREREQUISITES**
11+
12+
```bash
13+
# Check required versions
14+
python --version # >= 3.13
15+
uv --version # >= 0.8.11
16+
```
17+
18+
> ** ⚠️ IMPORTANTE: ** Asegúrese de que todas las dependencias estén actualizadas antes de continuar.
19+
20+
21+
## 🎯 **INSTALLING edit-python.pe**
22+
23+
### **Creating the access token**
24+
25+
1. Generate a [Personal access token (classic)](https://github.com/settings/tokens).
26+
2. Grant the scope: `public_repo`.
27+
3. Copy the token and keep it handy for the command below
28+
29+
30+
### 🌟 **For users seeking maximum speed**
31+
32+
```bash
33+
# 🚀 Single command to start the project
34+
uvx edit-python-pe
35+
36+
# 🎊 That's it! You can now enter your data
737
```
838

9-
After that, a text user interface would appear that allows you to create your
10-
profile and push it (create a PR) to the
11-
[python.pe](https://github.com/pythonpe/python.pe) repository.
39+
40+
41+
42+
43+
<div align="center">
44+
45+
## 🎊 **CONGRATULATIONS!**
46+
47+
### *You've completed the process*
48+
49+
![Success](https://img.shields.io/badge/STATUS-INSTALLATION%20SUCCESS-00ff88?style=for-the-badge&logo=checkmarx&logoColor=white)
50+
51+
**🤝 Contribute to the project****🐛 Report bugs****💡 Suggest improvements****⭐ Give us a star**
52+
53+
#### Built with ❤️ by the python.pe team
54+
55+
</div>
56+
57+
---
58+
59+
<div align="center">
60+
<sub>📋 Tutorial version: v1.0.0</sub>
61+
</div>

0 commit comments

Comments
 (0)