doc: add README

This commit is contained in:
0xMRTT 2023-05-02 00:34:40 +02:00
parent bc73e49fcf
commit a65820aecf
Signed by: 0xMRTT
GPG Key ID: 19C1449A774028BD

70
README.md Normal file
View File

@ -0,0 +1,70 @@
<h1 align="center">
<img src="data/icons/hicolor/scalable/apps/io.github.ImaginerApp.Imaginer.svg" alt="Imaginer" width="192" height="192"/>
<br>
Imaginer
</h1>
<p align="center">
<strong>Imagine with AI</strong>
</p>
<p align="center">
<a href="https://flathub.org/apps/details/io.github.ImaginerApp.Imaginer">
<img width="200" alt="Download on Flathub" src="https://dl.flathub.org/assets/badges/flathub-badge-i-en.svg"/>
</a>
<br>
</p>
<br>
<p align="center">
<a href="https://translate.codeberg.org/engage/Imaginer/">
<img src="https://translate.codeberg.org/widgets/Imaginer/-/svg-badge.svg" alt="Translation status" />
</a>
<a href="https://repology.org/project/Imaginer/versions">
<img alt="Packaging status" src="https://repology.org/badge/tiny-repos/Imaginer.svg">
</a>
</p>
<p align="center">
<a href="https://stopthemingmy.app">
<img alt="Please do not theme this app" src="https://stopthemingmy.app/badge.svg"/>
</a>
</p>
<p align="center">
<img src="./data/screenshots/preview.png" alt="Preview"/>
</p>
## Installation
### Flatpak
#### Flathub
> **Warn**: This app isn't yet on Flathub
##### Release
#### From Source
Clone the repo and run `flatpak-builder`
```
git clone https://codeberg.org/Imaginer/Imaginer # or https://github.com/ImaginerApp/Imaginer
cd Imaginer
flatpak-builder --install --user --force-clean repo/ build-aux/flatpak/io.github.ImaginerApp.Imaginer.json
```
## Contribute
The [GNOME Code of Conduct](https://wiki.gnome.org/Foundation/CodeOfConduct) is applicable to this project
### Translate
<a href="https://translate.codeberg.org/engage/Imaginer/">
<img src="https://translate.codeberg.org/widgets/Imaginer/-/multi-auto.svg" alt="Translation status" />
</a>
You can translate Imaginer using Codeberg Translate