Re-done readme.md

This commit is contained in:
Sohrab Behdani 2024-05-27 20:16:38 +03:30 committed by GitHub
parent 8301777472
commit 863c5e4c60
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,14 +1,14 @@
### vps2parch
# vps2parch 🚀
vps2parch is a shell script designed to transform any Linux-based VPS into a ParchLinux system. This script handles the complete process of downloading, extracting, and configuring the ParchLinux environment on your VPS.
**vps2parch** is a shell script designed to transform any Linux-based VPS into a ParchLinux system. This script handles the complete process of downloading, extracting, and configuring the ParchLinux environment on your VPS.
## Features
## Features
- Converts any Linux-based VPS to ParchLinux.
- Automates the download and installation process.
- Easy to use and minimal user interaction required.
- 🖥️ Converts any Linux-based VPS to ParchLinux.
- 🔄 Automates the download and installation process.
- 🤖 Easy to use and minimal user interaction required.
## Prerequisites
## Prerequisites 📋
Before running the script, ensure your VPS has the following tools installed:
@ -40,7 +40,7 @@ sudo dnf install curl tar wget aria2 -y
sudo pacman -Syu curl tar wget aria2
```
## Installation
## Installation 🛠️
1. Clone the repository or download the script directly:
@ -66,7 +66,7 @@ sudo pacman -Syu curl tar wget aria2
chmod +x vps2parch
```
## Usage
## Usage 🚀
Run the script with root privileges to begin the conversion process:
@ -76,17 +76,21 @@ sudo ./vps2parch
The script will guide you through the necessary steps to complete the installation. It will download the required ParchLinux files, extract them, and set up the system on your VPS.
## Note
## Note 📝
- This script will overwrite existing system files and configurations. Ensure you have backups of important data before proceeding.
- The conversion process may take some time depending on your network speed and VPS performance.
- ⚠️ **This script will overwrite existing system files and configurations. Ensure you have backups of important data before proceeding.**
- The conversion process may take some time depending on your network speed and VPS performance.
## License
## License 📄
See the [LICENSE](LICENSE) file for details.
## Contributing
## Contributing 🌟
Contributions are welcome! Please submit pull requests or open issues to help improve this project.
Enjoy your new ParchLinux system!
Enjoy your new ParchLinux system! 🎉
---
Thank you for using **vps2parch**! If you encounter any issues or have suggestions, feel free to reach out.