From 6be15a62880338c007bb426007bfba626112e5bf Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Wed, 16 Oct 2019 17:32:19 +0200 Subject: [PATCH] Simplify the README, add cool shiny logo, badges and screenshots --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b860c27d7..5fb72e260 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ +# YunoHost + [![Build status](https://travis-ci.org/YunoHost/yunohost.svg?branch=stretch-unstable)](https://travis-ci.org/YunoHost/yunohost) [![GitHub license](https://img.shields.io/github/license/YunoHost/yunohost)](https://github.com/YunoHost/yunohost/blob/stretch-unstable/LICENSE) +![Mastodon Follow](https://img.shields.io/mastodon/follow/28084) -# YunoHost core +This repository corresponds to the core code of YunoHost, mainly written in Python and Bash. -This repository is the core of YunoHost code. +You can learn more about what's YunoHost and its features [here](https://yunohost.org/#/whatsyunohost)! - [Project website](https://yunohost.org) -- [Bugtracker](https://github.com/YunoHost/issues). +- [Installation documentation](https://yunohost.org/install) +- [Issue tracker](https://github.com/YunoHost/issues) + +# Screenshots + +Webadmin ([Yunohost-Admin](https://github.com/YunoHost/yunohost-admin)) | Single-sign on user portal ([SSOwat](https://github.com/YunoHost/ssowat)) +--- | --- +![](https://raw.githubusercontent.com/YunoHost/doc/master/images/webadmin.png) | ![](https://raw.githubusercontent.com/YunoHost/doc/master/images/user_panel.png) + ## Contributing -- You can develop on this repository using [ynh-dev](https://github.com/YunoHost/ynh-dev) with `use-git` sub-command. -- On this repository we are [following this workflow](https://yunohost.org/#/build_system_en): `stable ← testing ← unstable ← your_branch`. -- Note: If you modify Python scripts, you will have to modifiy the actions map. +- You can learn how to get started with developing on YunoHost by reading [this piece of documentation](https://yunohost.org/dev). - You can help translate YunoHost on our [translation platform](https://translate.yunohost.org/engage/yunohost/?utm_source=widget) Translation status @@ -21,7 +30,7 @@ This repository is the core of YunoHost code. ## Repository content - [YunoHost core Python 2.7 scripts](./src/yunohost). -- [An actionsmap](./data/actionsmap/yunohost.yml) used by moulinette. +- [An actionsmap](./data/actionsmap/yunohost.yml) describing the CLI and API - [Services configuration templates](./data/templates). - [Hooks](./data/hooks). - [Locales](./locales) for translations of `yunohost` command. @@ -32,17 +41,10 @@ This repository is the core of YunoHost code. ## How does it work? - Python core scripts are accessible through two interfaces thanks to the [moulinette framework](https://github.com/YunoHost/moulinette): - - [CLI](https://en.wikipedia.org/wiki/Command-line_interface) for `yunohost` command. - - [API](https://en.wikipedia.org/wiki/Application_programming_interface) for [web administration module](https://github.com/YunoHost/yunohost-admin) (other modules could be implemented). + - the [CLI](https://en.wikipedia.org/wiki/Command-line_interface) corresponding to the `yunohost` command. + - the [API](https://en.wikipedia.org/wiki/Application_programming_interface) used by the [web administration interface](https://github.com/YunoHost/yunohost-admin) (other interfaces could be implemented). - You can find more details about how YunoHost works on this [documentation (in French)](https://yunohost.org/#/package_list_fr). -## Dependencies - -- [Python 2.7](https://www.python.org/download/releases/2.7) -- [Moulinette](https://github.com/YunoHost/moulinette) -- [Bash](https://www.gnu.org/software/bash/bash.html) -- [Debian Stretch](https://www.debian.org/releases/stretch) - ## License -As [other components of YunoHost core code](https://yunohost.org/#/faq_en), this repository is licensed GNU AGPL v3. +As [other components of YunoHost](https://yunohost.org/#/faq_en), this repository is licensed GNU AGPL v3.