1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/overleaf_ynh.git synced 2024-09-03 19:56:27 +02:00
overleaf_ynh/README.md
2024-07-05 01:43:30 +00:00

48 lines
1.9 KiB
Markdown

<!--
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand.
-->
# Overleaf for YunoHost
[![Integration level](https://dash.yunohost.org/integration/overleaf.svg)](https://ci-apps.yunohost.org/ci/apps/overleaf/) ![Working status](https://ci-apps.yunohost.org/ci/badges/overleaf.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/overleaf.maintain.svg)
[![Install Overleaf with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=overleaf)
*[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install Overleaf quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview
Overleaf is an open-source online real-time collaborative LaTeX editor.
**Shipped version:** 2024.07.04~ynh1
## Screenshots
![Screenshot of Overleaf](./doc/screenshots/screenshot.png)
## Documentation and resources
- Official app website: <https://www.overleaf.com>
- Official user documentation: <https://www.overleaf.com/learn>
- Upstream app code repository: <https://github.com/overleaf/overleaf>
- YunoHost Store: <https://apps.yunohost.org/app/overleaf>
- Report a bug: <https://github.com/YunoHost-Apps/overleaf_ynh/issues>
## Developer info
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/overleaf_ynh/tree/testing).
To try the `testing` branch, please proceed like that:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/overleaf_ynh/tree/testing --debug
or
sudo yunohost app upgrade overleaf -u https://github.com/YunoHost-Apps/overleaf_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>