wallabag/README.md

41 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" />
[![Build Status](https://api.travis-ci.org/wallabag/wallabag.svg?branch=master)](https://travis-ci.org/wallabag/wallabag)
2016-08-11 18:57:06 +00: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 19:02:31 +00:00
[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag)
[![Translation status](https://hosted.weblate.org/widgets/wallabag/-/svg-badge.svg)](https://hosted.weblate.org/engage/wallabag/?utm_source=widget)
2015-04-02 09:45:53 +00:00
2016-01-13 23:41:08 +00:00
# What is wallabag?
2017-08-10 18:54:58 +00:00
wallabag is a self-hostable PHP application allowing you to not miss any content anymore.
2016-01-13 23:41:08 +00: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 16:17:13 +00:00
More information on our website: [wallabag.org](https://wallabag.org).
2017-02-18 14:04:57 +00:00
If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it).
2016-04-03 08:08:22 +00:00
# Install wallabag
Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html).
2016-01-13 23:41:08 +00:00
2016-03-08 10:40:37 +00:00
Then you can install wallabag by executing the following commands:
```bash
2016-10-10 07:11:26 +00:00
git clone https://github.com/wallabag/wallabag.git
2018-10-24 19:02:35 +00:00
cd wallabag && make install
```
2018-10-24 19:02:35 +00:00
Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag.
2017-12-12 19:52:05 +00: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 19:02:35 +00:00
Copyright © 2013-current Nicolas Lœuillet <nicolas@loeuillet.org>
2013-04-03 13:14:01 +00: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.