From f8daac618f446d2a4401315b860c84c6c3090115 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 9 Mar 2024 06:21:23 +0100 Subject: [PATCH] Readme: add pictures alt text and some markdown standardization --- README.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9545643a..1b6728c8 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,37 @@

YunoHost Admin

- ![Version](https://img.shields.io/github/v/tag/yunohost/yunohost-admin?label=version&sort=semver) [![Tests status](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml/badge.svg)](https://github.com/YunoHost/yunohost-admin/actions/workflows/eslint.yml) [![Project license](https://img.shields.io/gitlab/license/yunohost/yunohost)](https://github.com/YunoHost/yunohost/blob/dev/LICENSE) -[YunoHost](https://yunohost.org) administration web interface (VueJS client for the API). +[YunoHost logo](https://yunohost.org) administration web interface (VueJS client for the API). -This client is a part of the YunoHost project, and can not be installed directly. Please visit the YunoHost website for [installation instructions](https://yunohost.org/install). - -![](./doc/home.png) +This client is a part of the YunoHost project, and can not be installed directly. +Please visit the YunoHost website for [installation instructions](https://yunohost.org/install). +![Web admin insterface screenshot](./doc/home.png)
-Issues ------- +## Issues - [Please report issues on YunoHost bugtracker](https://github.com/YunoHost/issues). -Translation ------------ +## Translation You can help translate Yunohost-Admin on our [translation platform](https://translate.yunohost.org/engage/yunohost/?utm_source=widget) -
Translation status
+
View of the translation rate for the different languages available in YunoHost
-Developpers -------------- +## Developpers Contributions are welcome! -In order to contribute you will need to setup a development environment using [ynh-dev](https://github.com/YunoHost/ynh-dev) (see the README). +In order to contribute you will need to setup a development environment using [ynh-dev](https://github.com/YunoHost/ynh-dev) (see the README). Once you have a environment running and are attached to it (with `./ynh-dev start`) you will be able to run: -``` -$ ./ynh-dev use-git yunohost-admin +```bash +./ynh-dev use-git yunohost-admin ``` This command will install all dependencies and start a dev server (based on [webpack-dev-server](https://github.com/webpack/webpack-dev-server)) with Hot-Module-Replacement (live updates on code modification without reloading the page nor rebuilding the whole code). After the build step, click on the "Network:" link and you are good to go.