]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - README.md
Type-hint 'Action' for onEndProfileSettingsActions()
[quix0rs-gnu-social.git] / README.md
index c705dd54125d6b3985a1ae422f1c0f5176921e00..6dacd2ee7941007251d1ebbfb8889baaf351de0f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,22 @@
-# GNU social 1.1.2 (alpha)
-August 2014
-
-(c) Free Software Foundation, Inc
-(c) StatusNet, Inc
+# GNU social 2.0.x
+(c) 2010-2019 Free Software Foundation, Inc
 
 This is the README file for GNU social, the free
 software social networking platform. It includes
 general information about the software and the
 project.
 
-Some other files to review:
+The file INSTALL.md has useful instructions on how to
+install this software.
+
+System administrators may find the `DOCUMENTATION/SYSTEM_ADMINISTRATORS`
+directory useful, namely:
 
-- INSTALL: instructions on how to install the software.
-- UPGRADE: upgrading from earlier versions
-- CONFIGURE: configuration options in gruesome detail.
-- PLUGINS.txt: how to install and configure plugins.
-- EVENTS.txt: events supported by the plugin system
-- COPYING: full text of the software license
+- upgrade_from: upgrading from different software
+- CONFIGURE.md: configuration options in gruesome detail.
+- PLUGINS.md: how to install and configure plugins.
 
-Information on using GNU social can be found in
-the "doc" subdirectory or in the "help" section
-on-line, or you can catch us on IRC in #social on
-the freenode network.
+Developers may find the `DOCUMENTATION/DEVELOPERS` directory useful.
 
 ## About
 
@@ -32,29 +27,27 @@ polls, announce events, or other social activities
 (and you can add more!). Users can choose which
 people to "follow" and receive only their friends'
 or colleagues' status messages. It provides a
-similar service to sites like Twitter, Google+ or
-Facebook, but is much more awesome.
+similar service to proprietary social network sites,
+but is much more awesome.
 
 With a little work, status messages can be sent to
 mobile phones, instant messenger programs (using
 XMPP), and specially-designed desktop clients that
 support the Twitter API.
 
-GNU social supports an open standard called
-OStatus <http://ostatus.org/> that lets users in
+GNU social supports open standards (such as OStatus
+<https://www.w3.org/community/ostatus/>) that lets users in
 different networks follow each other. It enables a
 distributed social network spread all across the
 Web.
 
-GNU social was originally developed for the
-service, Identi.ca <http://identi.ca/>.
+GNU social was originally developed as "StatusNet" by
+StatusNet, Inc. with Evan Prodromou as lead developer.
 
 It is shared with you in hope that you too make an
 service available to your users. To learn more,
 please see the Open Software Service Definition
-1.1:
-
-    http://www.opendefinition.org/ossd
+1.1: <http://www.opendefinition.org/ossd>
 
 ### License
 
@@ -82,16 +75,16 @@ License along with this program, in the file "COPYING".  If not, see
 
 Documentation in the /doc-src/ directory is available under the
 Creative Commons Attribution 3.0 Unported license, with attribution to
-"GNU social". See http://creativecommons.org/licenses/by/3.0/ for details.
+"GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
 
 CSS and images in the /theme/ directory are available under the
 Creative Commons Attribution 3.0 Unported license, with attribution to
-"GNU social". See http://creativecommons.org/licenses/by/3.0/ for details.
+"GNU social". See <http://creativecommons.org/licenses/by/3.0/> for details.
 
 Our understanding and intention is that if you add your own theme that
 uses only CSS and images, those files are not subject to the copyleft
 requirements of the Affero General Public License 3.0. See
-http://wordpress.org/news/2009/07/themes-are-gpl-too/ . This is not
+<http://wordpress.org/news/2009/07/themes-are-gpl-too/>. This is not
 legal advice; consult your lawyer.
 
 Additional library software has been made available in the 'extlib'
@@ -100,25 +93,7 @@ liberal terms, but those terms may differ in detail from the AGPL's
 particulars. See each package's license file in the extlib directory
 for additional terms.
 
-## New this version
-
-This is a security fix and bug fix release since 1.1.1-alpha2.
-The current release base version, 1.1.2, began work on 2014-10-25.
-All 1.1.1 sites should upgrade to this version.
-
-So far it includes the following changes:
-
-- XSS security fix (thanks Simon Waters, https://www.surevine.com/ )
-
-Upgrades from _StatusNet_ 1.1.1 will also experience these improvements:
-
-- Fixes for SQL injection errors in profile lists.
-- Improved ActivityStreams JSON representation of activities and objects.
-- Upgrade to the Twitter 1.1 API.
-- More robust handling of errors in distribution.
-- Fix error in OStatus subscription for remote groups.
-- Fix error in XMPP distribution.
-
+Refer to COPYING.md for full text of the software license..
 
 ### Troubleshooting
 
@@ -140,107 +115,43 @@ to install the development version of GNU social.
 To get it, use the git version control tool
 <http://git-scm.com/> like so:
 
-    git clone git@gitorious.org:social/mainline.git
+    git clone git@notabug.org:diogo/gnu-social.git
 
 In the current phase of development it is probably
 recommended to use git as a means to stay up to date
 with the source code. You can choose between these
 branches:
-- 1.1.x     "stable", few updates, well tested code
-- master    "testing", more updates, usually working well
-- nightly   "unstable", most updates, not always working
+* 1.20.x    "oldstable", few updates, well tested coded
+* master    "stable", usually working well
+* nightly   "testing", most updates, not always working as expected
+
+To keep it up-to-date, use `git pull`. Watch for conflicts!
 
-To keep it up-to-date, use 'git pull'. Watch for conflicts!
+As in any upgrade, do __not__ forget to run `/scripts/upgrade.php`.
 
 ## Further information
 
 There are several ways to get more information about GNU social.
 
-* The #social IRC channel on freenode.net <http://www.freenode.net/>.
-* The GNU social website
-* Following us on GNU social -- http://quitter.se/gnusocial
+* The #social IRC channel on freenode.net <https://www.freenode.net/>.
+* The unofficial XMPP room linked to IRC on <xmpp:gnusocial@conference.bka.li>
+* The GNU social website <https://gnu.io/social/>
 
 * GNU social has a bug tracker for any defects you may find, or ideas for
-  making things better. http://bugz.foocorp.net/
-* Patches are welcome, either on the bug tracker or our repository at
-  Gitorious. https://gitorious.org/social/mainline
-
-Credits
-=======
-
-The following is an incomplete list of developers
-who've worked on GNU social, or its predecessors
-StatusNet and Free Social. Apologies for any
-oversight; please let mattl@gnu.org know if
-anyone's been overlooked in error.
-
-## Project Founders
-
-* Matt Lee (GNU social)
-* Evan Prodromou (StatusNet)
-* Mikael Nordfeldth (Free Social)
-
-Thanks to all of the StatusNet developers:
-
-* Zach Copley, StatusNet, Inc.
-* Earle Martin, StatusNet, Inc.
-* Marie-Claude Doyon, designer, StatusNet, Inc.
-* Sarven Capadisli, StatusNet, Inc.
-* Robin Millette, StatusNet, Inc.
-* Ciaran Gultnieks
-* Michael Landers
-* Ori Avtalion
-* Garret Buell
-* Mike Cochrane
-* Matthew Gregg
-* Florian Biree
-* Erik Stambaugh
-* 'drry'
-* Gina Haeussge
-* Tryggvi Björgvinsson
-* Adrian Lang
-* Ori Avtalion
-* Meitar Moscovitz
-* Ken Sheppardson (Trac server, man-about-town)
-* Tiago 'gouki' Faria (i18n manager)
-* Sean Murphy
-* Leslie Michael Orchard
-* Eric Helgeson
-* Ken Sedgwick
-* Brian Hendrickson
-* Tobias Diekershoff
-* Dan Moore
-* Fil
-* Jeff Mitchell
-* Brenda Wallace
-* Jeffery To
-* Federico Marani
-* mEDI
-* Brett Taylor
-* Brigitte Schuster
-* Siebrand Mazeland and the amazing volunteer translators at translatewiki.net
-* Brion Vibber, StatusNet, Inc.
-* James Walker, StatusNet, Inc.
-* Samantha Doherty, designer, StatusNet, Inc.
-* Simon Waters, Surevine
-
-### Extra special thanks to the GNU socialites
-
-* Craig Andrews
-* Donald Robertson
-* Deb Nicholson
-* Ian Denhart
-* Steven DuBois
-* Blaine Cook
-* Henry Story
-* Melvin Carvalho
-
-Thanks also to the developers of our upstream
-library code and to the thousands of people who
-have tried out GNU social, told their friends, and
-built the fediverse network to what it is today.
-
-### License help from
-
-* Bradley M. Kuhn
+  making things better. <https://notabug.org/diogo/gnu-social/issues>
+* Patches are welcome, preferrably to our repository on notabug.org. <https://notabug.org/diogo/gnu-social>
+
+## Credits
+
+An incomplete list of developers who've worked on GNU social,
+or its predecessors StatusNet and Free Social has been made available
+in `CREDITS.md`.
+
+### Current team
 
+* Matt Lee
+* Mikael Nordfeldth
+* Diogo Cordeiro
+* Bruno Casteleiro
+* Miguel Dantas
+* Alexei Sorokin