README.md

   1 # GNU social 1.3.x
   2 2015
   3
   4 (c) Free Software Foundation, Inc
   5
   6 This is the README file for GNU social, the free
   7 software social networking platform. It includes
   8 general information about the software and the
   9 project.
  10
  11 Some other files to review:
  12
  13 - INSTALL: instructions on how to install the software.
  14 - UPGRADE: upgrading from earlier versions
  15 - CONFIGURE: configuration options in gruesome detail.
  16 - PLUGINS.txt: how to install and configure plugins.
  17 - EVENTS.txt: events supported by the plugin system
  18 - COPYING: full text of the software license
  19
  20 Information on using GNU social can be found in
  21 the "doc" subdirectory or in the "help" section
  22 on-line, or you can catch us on IRC in #social on
  23 the freenode network.
  24
  25 ## About
  26
  27 GNU social is a free social networking
  28 platform. It helps people in a community, company
  29 or group to exchange short status updates, do
  30 polls, announce events, or other social activities
  31 (and you can add more!). Users can choose which
  32 people to "follow" and receive only their friends'
  33 or colleagues' status messages. It provides a
  34 similar service to proprietary social network sites,
  35 but is much more awesome.
  36
  37 With a little work, status messages can be sent to
  38 mobile phones, instant messenger programs (using
  39 XMPP), and specially-designed desktop clients that
  40 support the Twitter API.
  41
  42 GNU social supports an open standard called
  43 OStatus <https://www.w3.org/community/ostatus/> that lets users in
  44 different networks follow each other. It enables a
  45 distributed social network spread all across the
  46 Web.
  47
  48 GNU social was originally developed as "StatusNet" by
  49 StatusNet, Inc. with Evan Prodromou as lead developer.
  50
  51 It is shared with you in hope that you too make an
  52 service available to your users. To learn more,
  53 please see the Open Software Service Definition
  54 1.1: <http://www.opendefinition.org/ossd>
  55
  56 ### License
  57
  58 This program is free software: you can redistribute it and/or modify
  59 it under the terms of the GNU Affero General Public License as
  60 published by the Free Software Foundation, either version 3 of the
  61 License, or (at your option) any later version.
  62
  63 This program is distributed in the hope that it will be useful, but
  64 WITHOUT ANY WARRANTY; without even the implied warranty of
  65 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  66 Affero General Public License for more details.
  67
  68 You should have received a copy of the GNU Affero General Public
  69 License along with this program, in the file "COPYING".  If not, see
  70 <http://www.gnu.org/licenses/>.
  71
  72     IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
  73     *different requirements* from the "regular" GPL. In particular, if
  74     you make modifications to the GNU social source code on your server,
  75     you *MUST MAKE AVAILABLE* the modified version of the source code
  76     to your users under the same license. This is a legal requirement
  77     of using the software, and if you do not wish to share your
  78     modifications, *YOU MAY NOT INSTALL GNU SOCIAL*.
  79
  80 Documentation in the /doc-src/ directory is 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 CSS and images in the /theme/ directory are available under the
  85 Creative Commons Attribution 3.0 Unported license, with attribution to
  86 "GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
  87
  88 Our understanding and intention is that if you add your own theme that
  89 uses only CSS and images, those files are not subject to the copyleft
  90 requirements of the Affero General Public License 3.0. See
  91 <http://wordpress.org/news/2009/07/themes-are-gpl-too/>. This is not
  92 legal advice; consult your lawyer.
  93
  94 Additional library software has been made available in the 'extlib'
  95 directory. All of it is Free Software and can be distributed under
  96 liberal terms, but those terms may differ in detail from the AGPL's
  97 particulars. See each package's license file in the extlib directory
  98 for additional terms.
  99
 100 ### Troubleshooting
 101
 102 The primary output for GNU social is syslog,
 103 unless you configured a separate logfile. This is
 104 probably the first place to look if you're getting
 105 weird behaviour from GNU social.
 106
 107 If you're tracking the unstable version of
 108 GNU social in the git repository (see below), and you
 109 get a compilation error ("unexpected T_STRING") in
 110 the browser, check to see that you don't have any
 111 conflicts in your code.
 112
 113 ### Unstable version
 114
 115 If you're adventurous or impatient, you may want
 116 to install the development version of GNU social.
 117 To get it, use the git version control tool
 118 <http://git-scm.com/> like so:
 119
 120     git clone git@git.gnu.io:gnu/gnu-social.git
 121
 122 In the current phase of development it is probably
 123 recommended to use git as a means to stay up to date
 124 with the source code. You can choose between these
 125 branches:
 126 - master    "stable", more updates, usually working well
 127 - nightly   "unstable", most updates, not always working
 128
 129 To keep it up-to-date, use 'git pull'. Watch for conflicts!
 130
 131 ## Further information
 132
 133 There are several ways to get more information about GNU social.
 134
 135 * The #social IRC channel on freenode.net <https://www.freenode.net/>.
 136 * The unofficial XMPP room linked to IRC on <xmpp:gnusocial@conference.bka.li>
 137 * The GNU social website <https://gnu.io/social/>
 138 * Following us on GNU social -- <https://quitter.se/gnusocial>
 139
 140 * GNU social has a bug tracker for any defects you may find, or ideas for
 141   making things better. <https://git.gnu.io/gnu/gnu-social/issues/>
 142 * Patches are welcome, preferrably to our repository on git.gnu.io. <https://git.gnu.io/gnu/gnu-social>
 143
 144 Credits
 145 =======
 146
 147 The following is an incomplete list of developers
 148 who've worked on GNU social, or its predecessors
 149 StatusNet and Free Social. Apologies for any
 150 oversight; please let mattl@gnu.org know if
 151 anyone's been overlooked in error.
 152
 153 ## Project Founders
 154
 155 * Matt Lee (GNU social)
 156 * Evan Prodromou (StatusNet)
 157 * Mikael Nordfeldth (Free Social)
 158
 159 Thanks to all of the StatusNet developers:
 160
 161 * Zach Copley, StatusNet, Inc.
 162 * Earle Martin, StatusNet, Inc.
 163 * Marie-Claude Doyon, designer, StatusNet, Inc.
 164 * Sarven Capadisli, StatusNet, Inc.
 165 * Robin Millette, StatusNet, Inc.
 166 * Ciaran Gultnieks
 167 * Michael Landers
 168 * Ori Avtalion
 169 * Garret Buell
 170 * Mike Cochrane
 171 * Matthew Gregg
 172 * Florian Biree
 173 * Erik Stambaugh
 174 * 'drry'
 175 * Gina Haeussge
 176 * Tryggvi Björgvinsson
 177 * Adrian Lang
 178 * Ori Avtalion
 179 * Meitar Moscovitz
 180 * Ken Sheppardson (Trac server, man-about-town)
 181 * Tiago 'gouki' Faria (i18n manager)
 182 * Sean Murphy
 183 * Leslie Michael Orchard
 184 * Eric Helgeson
 185 * Ken Sedgwick
 186 * Brian Hendrickson
 187 * Tobias Diekershoff
 188 * Dan Moore
 189 * Fil
 190 * Jeff Mitchell
 191 * Brenda Wallace
 192 * Jeffery To
 193 * Federico Marani
 194 * mEDI
 195 * Brett Taylor
 196 * Brigitte Schuster
 197 * Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
 198 * Brion Vibber, StatusNet, Inc.
 199 * James Walker, StatusNet, Inc.
 200 * Samantha Doherty, designer, StatusNet, Inc.
 201 * Simon Waters, Surevine
 202 * Joshua Judson Rosen (rozzin)
 203
 204 ### Extra special thanks to the GNU socialites
 205
 206 * Craig Andrews
 207 * Donald Robertson
 208 * Deb Nicholson
 209 * Ian Denhart
 210 * Steven DuBois
 211 * Blaine Cook
 212 * Henry Story
 213 * Melvin Carvalho
 214
 215 Thanks also to the developers of our upstream
 216 library code and to the thousands of people who
 217 have tried out GNU social, told their friends, and
 218 built the fediverse network to what it is today.
 219
 220 ### License help from
 221
 222 * Bradley M. Kuhn