From 062725fd0002a3a2906859338cd5dfc0d3300a2f Mon Sep 17 00:00:00 2001
From: 0xMRTT <0xMRTT@proton.me>
Date: Wed, 19 Jul 2023 20:01:01 +0200
Subject: [PATCH] feat: add README back
---
README.md | 127 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 125 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 94f39a7..fad1117 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,126 @@
-# bavarder
+
+
+ 
+
+ Bavarder
+
-A description of this project.
+
+ Chit-chat with an AI
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+
+
+ 
+
+
+
+
+
+ 
+
+
+
+## Usage
+
+Documentation is available [here](https://bavarder.codeberg.page)
+
+## Installation
+
+### Flatpak
+
+You can either use your GNOME Software and search for "Bavarder" or you can run
+
+``` shell
+flatpak install io.github.Bavarder.Bavarder
+```
+
+### Latest
+
+You can download a flatpak from the latest commit [here](https://codeberg.org/Bavarder/-/packages/generic/bavarder/). Run
+
+``` shell
+curl -s -o bavarder.flatpak https://codeberg.org/api/packages/Bavarder/generic/Bavarder/164/bavarder.flatpak && flatpak install --user bavarder.flatpak -y
+```
+
+#### From Source
+
+### Flatpak-builder
+
+Clone the repo and run `flatpak-builder`
+
+``` shell
+git clone https://codeberg.org/Bavarder/Bavarder # or https://github.com/Bavarder/Bavarder
+cd Bavarder
+flatpak-builder --install --user --force-clean repo/ build-aux/flatpak/io.github.Bavarder.Bavarder.json
+```
+### Meson
+
+``` shell
+git clone https://codeberg.org/Bavarder/Bavarder # or https://github.com/Bavarder/Bavarder
+cd Bavarder
+meson setup build # Configure the build environment in subdirectory 'build'
+meson compile -C build
+meson check -C build
+meson install -C build
+chmod 0755 /usr/local/bin/bavarder # Fix binary permissions
+```
+
+### Others
+
+You can see more install methods on the [website](https://bavarder.codeberg.page/install/)
+
+## Contribute
+
+The [GNOME Code of Conduct](https://wiki.gnome.org/Foundation/CodeOfConduct) is applicable to this project
+
+See [`SEEN.md`](./SEEN.md) for a list of articles and posts about Bavarder
+
+### Translate
+
+
+ 
+
+
+You can translate Bavarder using [Codeberg Translate](https://translate.codeberg.org/engage/bavarder/)
+
+## Mirrors
+
+- [GitHub](https://github.com/Bavarder/Bavarder)
+- [GitLab](https://gitlab.com/Bavarder/Bavarder)
+- [Codeberg](https://codeberg.org/Bavarder/Bavarder)
+
+## About the name
+
+Bavarder is a french word, the definiton of Bavarder is "Parler abondamment de choses sans grande portée" (Talking a lot about things that don't matter) (Larousse) which can be translated by Chit-Chat (informal conversation about matters that are not important). For non-french speakers, Bavarder can be hard to speak, it's prounouced as [bavaʀde]. Hear [here](https://youtu.be/9Qoogwxo5YA)
+
+## See also
+
+### [Imaginer : Imagine with AI](https://imaginer.codeberg.page)
+
+A tool for generating pictures with AI (GNOME app)
+
+- [GitHub](https://github.com/ImaginerApp/Imaginer)
+- [Codeberg](https://codeberg.org/Imaginer/Imaginer)