mirror of
https://github.com/redicculus/arch2appimage.git
synced 2025-05-27 21:00:15 -07:00
118 lines
3.6 KiB
Markdown
118 lines
3.6 KiB
Markdown
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
|
<a name="readme-top"></a>
|
|
<!--
|
|
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
|
*** that would make this better, please fork the repo and create a pull request
|
|
*** or simply open an issue with the tag "enhancement".
|
|
*** Don't forget to give the project a star!
|
|
*** Thanks again! Now go create something AMAZING! :D
|
|
-->
|
|
## Deprecation Notice
|
|
|
|
After having lots of stability issues with arch linux I moved to Ubuntu. My initial plan was to ditch the custom downloader and use pacman/yay to download/compile packages. But as I am not on arch anymore I will not be making any upgrades to the project. Thank you all for the support you have shown to the project.
|
|
|
|
|
|
<!-- PROJECT SHIELDS -->
|
|
<!--
|
|
*** I'm using markdown "reference style" links for readability.
|
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
*** See the bottom of this document for the declaration of the reference variables
|
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
-->
|
|
|
|
|
|
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<div align="center">
|
|
<h3 align="center">arch2appimage</h3>
|
|
|
|
<p align="center">
|
|
A Python script to convert any arch linux package (official/AUR) to an AppImage
|
|
<br />
|
|
<a href="#"><strong>Explore the docs »</strong></a>
|
|
<br />
|
|
<br />
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
<ul>
|
|
<li><a href="#built-with">Built With</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#getting-started">Getting Started</a>
|
|
<ul>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#installation">Installation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#usage">Usage</a></li>
|
|
<li><a href="#roadmap">Roadmap</a></li>
|
|
<li><a href="#contributing">Contributing</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
This goal of this project is to be able to convert arch linux packages either from the offcial Arch Linux Repositories or from the AUR (Chaotic AUR to be exact).
|
|
|
|
Use this `README.md` to get started.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- GETTING STARTED -->
|
|
## Getting Started
|
|
### Prerequisites
|
|
This project was written in python. To be able to run this you must have Python 3 installed. To install the required packages you also need to have pip installed.
|
|
|
|
### Installation
|
|
1. Install the requirements
|
|
```sh
|
|
pip3 install -r requirements.txt
|
|
```
|
|
This should be enough to run the program.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- USAGE EXAMPLES -->
|
|
## Usage
|
|
To start the program simply run
|
|
```sh
|
|
python3 arch2appimage.py
|
|
```
|
|
|
|
By default the script supports AUR. If you wish to disable that set `USE_AUR = False` in the `config.py` file.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- LICENSE -->
|
|
## License
|
|
|
|
Distributed under the GPL3 License. See `LICENSE.txt` for more information.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- ACKNOWLEDGMENTS -->
|
|
## Acknowledgments
|
|
This project was heavily inspired by
|
|
|
|
* [Arch-Deployer](hthttps://github.com/ivan-hc/Arch-Deployer)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|