wallabag/README.md

42 lines
2.3 KiB
Markdown
Raw Normal View History

<img src="https://raw.githubusercontent.com/wallabag/logo/master/_default/typo-horizontal/png/sm/logo-typo-horizontal-black-no-bg-no-border-sm.png" align="right" />
2020-11-23 22:39:32 +01:00
![CI](https://github.com/wallabag/wallabag/workflows/CI/badge.svg)
2016-08-11 20:57:06 +02:00
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=master)
2016-01-24 20:02:31 +01:00
[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag)
[![Donation Status](https://img.shields.io/liberapay/goal/wallabag.svg?logo=liberapay)](https://liberapay.com/wallabag/donate)
[![Translation status](https://hosted.weblate.org/widgets/wallabag/-/svg-badge.svg)](https://hosted.weblate.org/engage/wallabag/?utm_source=widget)
2015-04-02 11:45:53 +02:00
2016-01-14 00:41:08 +01:00
# What is wallabag?
2017-08-10 20:54:58 +02:00
wallabag is a self-hostable PHP application allowing you to not miss any content anymore.
2016-01-14 00:41:08 +01:00
Click, save and read it when you can. It extracts content so that you can read it when you have time.
2013-08-12 18:17:13 +02:00
More information on our website: [wallabag.org](https://wallabag.org).
2017-02-18 15:04:57 +01:00
If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).
2016-04-03 10:08:22 +02:00
# Install wallabag
Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html).
2016-01-14 00:41:08 +01:00
2016-03-08 11:40:37 +01:00
Then you can install wallabag by executing the following commands:
```bash
2016-10-10 09:11:26 +02:00
git clone https://github.com/wallabag/wallabag.git
2018-10-24 21:02:35 +02:00
cd wallabag && make install
```
2018-10-24 21:02:35 +02:00
Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag.
2017-12-12 20:52:05 +01:00
# Run on YunoHost
[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2)
Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh)
# Translate wallabag
[wallabag](https://hosted.weblate.org/projects/wallabag/) is being translated using [Weblate](https://weblate.org/), a web tool designed to ease translating for both developers and translators. Feel free to help us [translate wallabag](https://hosted.weblate.org/projects/wallabag/)!
# License
2018-10-24 21:02:35 +02:00
Copyright © 2013-current Nicolas Lœuillet <nicolas@loeuillet.org>
2013-04-03 15:14:01 +02:00
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the COPYING file for more details.