Imaginer/README.md
0xMRTT a38500decb
Some checks failed
Build / Flatpak (x86_64) (push) Failing after -21s
Update 'README.md'
2023-05-07 23:13:29 +00:00

95 lines
2.3 KiB
Markdown

<h1 align="center">
<img src="data/icons/hicolor/scalable/apps/page.codeberg.Imaginer.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/page.codeberg.Imaginer.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/avocado-armchair.png" alt="Preview"/>
</p>
## Installation
### Flatpak
#### Flathub
You can either use your GNOME Software and search for "Imaginer" or you can run
``` shell
flatpak install page.codeberg.Imaginer.Imaginer
```
##### Release
#### From Source
Clone the repo and run `flatpak-builder`
```
git clone https://codeberg.org/Imaginer/Imaginer.git # or https://github.com/ImaginerApp/Imaginer.git
cd Imaginer
flatpak-builder --install --user --force-clean repo/ build-aux/flatpak/page.codeberg.Imaginer.Imaginer.json
```
## Contribute
The [GNOME Code of Conduct](https://wiki.gnome.org/Foundation/CodeOfConduct) is applicable to this project
### Release
- Bump meson version in `meson.build`
- Bump version in the About dialog in `src/main.py`
- Add release notes to `data/page.codeberg.Imaginer.Imaginer.appdata.xml.in`
### 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
### Mirrors
- [GitHub](https://github.com/ImaginerApp/Imaginer)
- [Codeberg](https://github.com/Imaginer/Imaginer)
## See also
### Bavarder: Chit-Chat with AI
A tool for chatting with diverse AI
- https://github.com/Bavarder/Bavarder
- https://codeberg.org/Bavarder/Bavarder