cinecturlink2/README.md

56 lines
2.3 KiB
Markdown

# README
[![Release](https://img.shields.io/github/v/release/JcDenis/cinecturlink2)](https://github.com/JcDenis/cinecturlink2/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/cinecturlink2)](https://github.com/JcDenis/cinecturlink2/releases)
[![Issues](https://img.shields.io/github/issues/JcDenis/cinecturlink2)](https://github.com/JcDenis/cinecturlink2/issues)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.19-blue.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/cinecturlink2)
[![License](https://img.shields.io/github/license/JcDenis/cinecturlink2)](https://github.com/JcDenis/cinecturlink2/blob/master/LICENSE)
## WHAT IS CINECTURLINK2 ?
_cinecturlink2_ is a plugin for the open-source
web publishing software called Dotclear.
It help you to share books, musics and more with your visitor.
It is hightly based on cinecturlink for Dotclear 1
by Tigroux and maintain by brol.
## REQUIREMENTS
_cinecturlink2_ requires:
* admin perms for configuration
* contentadmin permissions for management
* Dotclear 2.19
* A writable directory on public path to store picture
* Note: it also creates dedicated database tables
## USAGE
First install _cinecturlink2_, manualy from a zip package or from
Dotaddict repository. (See Dotclear's documentation to know how do this)
Go to ''plugins manager'', expand _cinecturlink2_ information then
go to ''configure plugin'', fill in form.
Once it's done you can manage your cinecturlink from menu
''My cinecturlink'' on sidebar or you can add dashboard icon.
There are templates for public page. These template is adapted to
default Dotclear's theme. If you want to create your own template
for your theme, copy files from cinecturlink2/default-templates
to your theme tpl path and adapt them.
## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [GitHub Page](https://github.com/JcDenis/cinecturlink2)
* Packages & details: [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/cinecturlink2)
* Discuss and help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=40893)
## CONTRIBUTORS
* Jean-Christian Denis
You are welcome to contribute to this code.