README.md

   1 # GNU social 2.0.x
   2 (c) 2010-2019 Free Software Foundation, Inc
   3
   4 This is the README file for GNU social, the free
   5 software social networking platform. It includes
   6 general information about the software and the
   7 project.
   8
   9 The file INSTALL.md has useful instructions on how to
  10 install this software.
  11
  12 System administrators may find the `DOCUMENTATION/SYSTEM_ADMINISTRATORS`
  13 directory useful, namely:
  14
  15 - upgrade_from: upgrading from different software
  16 - CONFIGURE.md: configuration options in gruesome detail.
  17 - PLUGINS.md: how to install and configure plugins.
  18
  19 Developers may find the `DOCUMENTATION/DEVELOPERS` directory useful.
  20
  21 ## About
  22
  23 GNU social is a free social networking
  24 platform. It helps people in a community, company
  25 or group to exchange short status updates, do
  26 polls, announce events, or other social activities
  27 (and you can add more!). Users can choose which
  28 people to "follow" and receive only their friends'
  29 or colleagues' status messages. It provides a
  30 similar service to proprietary social network sites,
  31 but is much more awesome.
  32
  33 With a little work, status messages can be sent to
  34 mobile phones, instant messenger programs (using
  35 XMPP), and specially-designed desktop clients that
  36 support the Twitter API.
  37
  38 GNU social supports open standards (such as OStatus
  39 <https://www.w3.org/community/ostatus/>) that lets users in
  40 different networks follow each other. It enables a
  41 distributed social network spread all across the
  42 Web.
  43
  44 GNU social was originally developed as "StatusNet" by
  45 StatusNet, Inc. with Evan Prodromou as lead developer.
  46
  47 It is shared with you in hope that you too make an
  48 service available to your users. To learn more,
  49 please see the Open Software Service Definition
  50 1.1: <http://www.opendefinition.org/ossd>
  51
  52 ### License
  53
  54 This program is free software: you can redistribute it and/or modify
  55 it under the terms of the GNU Affero General Public License as
  56 published by the Free Software Foundation, either version 3 of the
  57 License, or (at your option) any later version.
  58
  59 This program is distributed in the hope that it will be useful, but
  60 WITHOUT ANY WARRANTY; without even the implied warranty of
  61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  62 Affero General Public License for more details.
  63
  64 You should have received a copy of the GNU Affero General Public
  65 License along with this program, in the file "COPYING".  If not, see
  66 <http://www.gnu.org/licenses/>.
  67
  68     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
  69     *different requirements* from the "regular" GPL. In particular, if
  70     you make modifications to the GNU social source code on your server,
  71     you *MUST MAKE AVAILABLE* the modified version of the source code
  72     to your users under the same license. This is a legal requirement
  73     of using the software, and if you do not wish to share your
  74     modifications, *YOU MAY NOT INSTALL GNU SOCIAL*.
  75
  76 Documentation in the /doc-src/ directory is available under the
  77 Creative Commons Attribution 3.0 Unported license, with attribution to
  78 "GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
  79
  80 CSS and images in the /theme/ directory are available under the
  81 Creative Commons Attribution 3.0 Unported license, with attribution to
  82 "GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
  83
  84 Our understanding and intention is that if you add your own theme that
  85 uses only CSS and images, those files are not subject to the copyleft
  86 requirements of the Affero General Public License 3.0. See
  87 <http://wordpress.org/news/2009/07/themes-are-gpl-too/>. This is not
  88 legal advice; consult your lawyer.
  89
  90 Additional library software has been made available in the 'extlib'
  91 directory. All of it is Free Software and can be distributed under
  92 liberal terms, but those terms may differ in detail from the AGPL's
  93 particulars. See each package's license file in the extlib directory
  94 for additional terms.
  95
  96 Refer to COPYING.md for full text of the software license..
  97
  98 ### Troubleshooting
  99
 100 The primary output for GNU social is syslog,
 101 unless you configured a separate logfile. This is
 102 probably the first place to look if you're getting
 103 weird behaviour from GNU social.
 104
 105 If you're tracking the unstable version of
 106 GNU social in the git repository (see below), and you
 107 get a compilation error ("unexpected T_STRING") in
 108 the browser, check to see that you don't have any
 109 conflicts in your code.
 110
 111 ### Unstable version
 112
 113 If you're adventurous or impatient, you may want
 114 to install the development version of GNU social.
 115 To get it, use the git version control tool
 116 <http://git-scm.com/> like so:
 117
 118     git clone git@notabug.org:diogo/gnu-social.git
 119
 120 In the current phase of development it is probably
 121 recommended to use git as a means to stay up to date
 122 with the source code. You can choose between these
 123 branches:
 124 * 1.20.x    "oldstable", few updates, well tested coded
 125 * master    "stable", usually working well
 126 * nightly   "testing", most updates, not always working as expected
 127
 128 To keep it up-to-date, use `git pull`. Watch for conflicts!
 129
 130 As in any upgrade, do __not__ forget to run `/scripts/upgrade.php`.
 131
 132 ## Further information
 133
 134 There are several ways to get more information about GNU social.
 135
 136 * The #social IRC channel on freenode.net <https://www.freenode.net/>.
 137 * The unofficial XMPP room linked to IRC on <xmpp:gnusocial@conference.bka.li>
 138 * The GNU social website <https://gnu.io/social/>
 139
 140 * GNU social has a bug tracker for any defects you may find, or ideas for
 141   making things better. <https://notabug.org/diogo/gnu-social/issues>
 142 * Patches are welcome, preferrably to our repository on notabug.org. <https://notabug.org/diogo/gnu-social>
 143
 144 ## Credits
 145
 146 An incomplete list of developers who've worked on GNU social,
 147 or its predecessors StatusNet and Free Social has been made available
 148 in `CREDITS.md`.
 149
 150 ### Current team
 151
 152 * Matt Lee
 153 * Mikael Nordfeldth
 154 * Diogo Cordeiro
 155 * Bruno Casteleiro
 156 * Miguel Dantas
 157 * Alexei Sorokin