README.md 1.75 KB
Newer Older
Rodrigo Souto's avatar
Rodrigo Souto committed
1
[![pipeline status](https://gitlab.com/noosfero/noosfero/badges/master/pipeline.svg)](https://gitlab.com/noosfero/noosfero/commits/master)
2 3
[![Code Climate](https://codeclimate.com/github/Noosfero/noosfero.png)](https://codeclimate.com/github/Noosfero/noosfero)

4
Noosfero - a web-based social platform
5
======================================
AntonioTerceiro's avatar
AntonioTerceiro committed
6

7 8 9 10 11 12
Communication
-------------

There is a Telegram group where you can reach the commity: https://t.me/noosferodev.

Don't be shy to hop in and ask for questions.
AntonioTerceiro's avatar
AntonioTerceiro committed
13

14 15
Documentation
-------------
AntonioTerceiro's avatar
AntonioTerceiro committed
16

17
The following documentation is available:
AntonioTerceiro's avatar
AntonioTerceiro committed
18

19 20
    File                     Purpose
    -----------------------  --------------------------------------------------------
21
    DEVELOPMENT.md           instructions about the development process
22 23 24 25 26 27 28 29 30
    INSTALL.md               install instructions
    INSTALL.awstats.md       install instructions - access statistics service
    INSTALL.chat.md          install instructions - chat service
    INSTALL.email.md         install instructions - email service
    INSTALL.multitenancy.md  install instructions - multiple sites
    INSTALL.varnish.md       install instructions - varnish HTTP caching (recommended)
    HACKING.md               development instruction
    RELEASING.md             instructions for doing releases
    doc/noosfero/*           user documentation (available through the app itself)
31 32 33 34 35 36 37


Authors and copyright
---------------------

Authorship and copyright information is available in the files listed below.

38 39 40 41
    File                  Purpose
    --------------------  -----------------------------------------
    AUTHORS.md            list of authors (updated at each release)
    COPYRIGHT             Copyright statement for the project
42
    COPYING               Full text of the project license