mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
Simplify the README, add cool shiny logo, badges and screenshots
This commit is contained in:
parent
77960fd405
commit
6be15a6288
1 changed files with 19 additions and 17 deletions
36
README.md
36
README.md
|
@ -1,18 +1,27 @@
|
|||
# <img alt="YunoHost" src="https://raw.githubusercontent.com/YunoHost/doc/master/images/logo_roundcorner.png" width="100px" />
|
||||
|
||||
[](https://travis-ci.org/YunoHost/yunohost)
|
||||
[](https://github.com/YunoHost/yunohost/blob/stretch-unstable/LICENSE)
|
||||

|
||||
|
||||
# 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))
|
||||
--- | ---
|
||||
 | 
|
||||
|
||||
|
||||
## 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)
|
||||
|
||||
<img src="https://translate.yunohost.org/widgets/yunohost/-/multi-auto.svg" alt="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.
|
||||
|
|
Loading…
Add table
Reference in a new issue