[fractal] readme: Improve formatting
- From: Julian Sparber <jsparber src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [fractal] readme: Improve formatting
- Date: Thu, 31 Mar 2022 10:47:18 +0000 (UTC)
commit dd4931ea7c36004c46fbc7a16a7c5317a6ae936b
Author: Kévin Commaille <zecakeh tedomum fr>
Date: Wed Mar 30 20:13:43 2022 +0200
readme: Improve formatting
Wrap lines at ~100 characters.
README.md | 57 +++++++++++++++++++++++++++++++--------------------------
1 file changed, 31 insertions(+), 26 deletions(-)
---
diff --git a/README.md b/README.md
index ecec8a1f0..823a7e92e 100644
--- a/README.md
+++ b/README.md
@@ -4,18 +4,28 @@
# Fractal
-Fractal is a Matrix messaging app for GNOME written in Rust. Its interface is optimized for collaboration in
large groups, such as free software projects.
+Fractal is a Matrix messaging app for GNOME written in Rust. Its interface is optimized for
+collaboration in large groups, such as free software projects.
![screenshot](https://gitlab.gnome.org/GNOME/fractal/raw/main/screenshots/fractal.png)
-
## Work in Progress
-We already talked several times in the past about rewriting the application, but for different reasons we
didn't do it. Now that the [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk) exists, which
does a lot of the heavy lifting for us, we have a good starting point to build Fractal without the need to
implement every single feature from the Matrix API. Finally with the release of GTK4 we would need to rework
most of Fractal's code anyways. Therefore, it just makes sense to start over and build Fractal with all the
features (e.g end-to-end encryption) we have in mind.
-A year ago we started working on rewriting [Fractal](https://gitlab.gnome.org/GNOME/fractal/) from scratch
using [GTK4](https://www.gtk.org/) and the [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk).
This effort was called fractal-next.
+We already talked several times in the past about rewriting the application, but for different
+reasons we didn't do it. Now that the [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk)
+exists, which does a lot of the heavy lifting for us, we have a good starting point to build Fractal
+without the need to implement every single feature from the Matrix API. Finally with the release of
+GTK4 we would need to rework most of Fractal's code anyways. Therefore, it just makes sense to start
+over and build Fractal with all the features (e.g end-to-end encryption) we have in mind.
-Fractal-next now replaced our previous codebase, and has become the new nightly version. It isn't yet ready
for a release and you can follow along our progress towards it by looking at the [feature parity
milestone](https://gitlab.gnome.org/GNOME/fractal/-/milestones/18) and [Fractal v5
(fractal-next)](https://gitlab.gnome.org/GNOME/fractal/-/milestones/21).
+A year ago we started working on rewriting [Fractal](https://gitlab.gnome.org/GNOME/fractal/) from
+scratch using [GTK4](https://www.gtk.org/) and the
[matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk).
+This effort was called fractal-next.
+Fractal-next now replaced our previous codebase, and has become the new nightly version. It isn't
+yet ready for a release and you can follow along our progress towards it by looking at the
+[feature parity milestone](https://gitlab.gnome.org/GNOME/fractal/-/milestones/18) and
+[Fractal v5 (fractal-next)](https://gitlab.gnome.org/GNOME/fractal/-/milestones/21).
## Installation instructions
@@ -54,6 +64,7 @@ flatpak install --user flathub org.freedesktop.Sdk.Extension.rust-stable//21.08
# Install the required llvm extension from Flathub
flatpak install --user flathub org.freedesktop.Sdk.Extension.llvm12//21.08
```
+
Move inside the `build-aux` folder and then build and install the app:
```
@@ -69,8 +80,8 @@ flatpak remove org.gnome.Fractal.Devel.json`
### GNU/Linux
-If you decide to ignore our recommendation and build on your host system,
-outside of Flatpak or snap, you will need Meson and Ninja (as well as Rust and Cargo).
+If you decide to ignore our recommendation and build on your host system, outside of Flatpak or
+snap, you will need Meson and Ninja (as well as Rust and Cargo).
```sh
meson . _build --prefix=/usr/local
@@ -80,46 +91,40 @@ sudo ninja -C _build install
### Translations
-Fractal is translated by the GNOME translation team on
-[Damned lies](https://l10n.gnome.org/).
+Fractal is translated by the GNOME translation team on [Damned lies](https://l10n.gnome.org/).
-If you want to add *a new language* you should update the file
-`fractal-gtk/po/LINGUAS` and add the code for that language
-to the list.
+If you want to add *a new language* you should update the file `fractal-gtk/po/LINGUAS` and add the
+code for that language to the list.
Get the pot file from [the Fractal module page on Damned lies](https://l10n.gnome.org/module/fractal/).
### Password Storage
Fractal uses [Secret Service](https://www.freedesktop.org/wiki/Specifications/secret-storage-spec/)
-to store the password so you should have something providing
-that service on your system. If you're using GNOME or KDE
-this should work for you out of the box with gnome-keyring or
-ksecretservice.
+to store the password so you should have something providing that service on your system. If you're
+using GNOME or KDE this should work for you out of the box with gnome-keyring or ksecretservice.
## Frequently Asked Questions
* Does Fractal have encryption support? Will it ever?
-Yes, Fractal-next has encryption support using Cross-Signing.
-See <https://gitlab.gnome.org/GNOME/fractal/-/issues/717> for more info on the state of encryption.
+Yes, Fractal-next has encryption support using Cross-Signing. See
+<https://gitlab.gnome.org/GNOME/fractal/-/issues/717> for more info on the state of encryption.
* Can I run Fractal with the window closed?
-Currently Fractal does not support this. Fractal is a
-GNOME application, and accordingly adheres GNOME
-guidelines and paradigms. This will be revisited if or
-when GNOME gets a "Do Not Disturb" feature.
+Currently Fractal does not support this. Fractal is a GNOME application, and accordingly adheres GNOME
+guidelines and paradigms. This will be revisited if or when GNOME gets a "Do Not Disturb" feature.
## The origin of Fractal
-Fractal-next is a complete rewrite of Fractal built on top of the
[matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk) using [GTK4](https://gtk.org/).
+Fractal-next is a complete rewrite of Fractal built on top of the
+[matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk) using [GTK4](https://gtk.org/).
The previous version of Fractal was using GTK3 and its own backend to talk to a matrix homeserver.
Initial versions were based on Fest <https://github.com/fest-im/fest>, formerly called ruma-gtk.
-In the origins of the project it was called guillotine, based on French revolution,
-in relation with the Riot client name, but it's a negative name so we decide
-to change for a math one.
+In the origins of the project it was called guillotine, based on French revolution, in relation with
+the Riot client name, but it's a negative name so we decide to change for a math one.
The name Fractal was proposed by Regina Bíró.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]