GNUsocial
/
gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[DOCUMENTATION] Update README.md

This commit is contained in:
Diogo Cordeiro 2019-06-02 18:09:38 +01:00
parent e7a875755d
commit 3886db64bc
2 changed files with 25 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
DOCUMENTATION/SYSTEM_ADMINISTRATORS/PLUGINS.txt → DOCUMENTATION/SYSTEM_ADMINISTRATORS/PLUGINS.md
View File

@ -10,13 +10,13 @@ and has a choice of accepting or rejecting the events.
In the simplest case, you can add a function to config.php and use the In the simplest case, you can add a function to config.php and use the
Event::addHandler() function to hook an event: Event::addHandler() function to hook an event:
function AddMyWebsiteLink($action) function AddMyWebsiteLink($action)
{ {
$action->menuItem('http://mywebsite.net/', _('My web site'), _('Example web link')); $action->menuItem('http://mywebsite.net/', _('My web site'), _('Example web link'));
return true; return true;
} }
Event::addHandler('EndPrimaryNav', 'AddMyWebsiteLink'); Event::addHandler('EndPrimaryNav', 'AddMyWebsiteLink');
This adds a menu item to the end of the main navigation menu. You can This adds a menu item to the end of the main navigation menu. You can
see the list of existing events, and parameters that handlers must see the list of existing events, and parameters that handlers must

42
README.md
View File

@ -1,26 +1,22 @@
# GNU social 1.3.x # GNU social 1.3.x
2015 (c) 2010 Free Software Foundation, Inc
(c) Free Software Foundation, Inc
This is the README file for GNU social, the free This is the README file for GNU social, the free
software social networking platform. It includes software social networking platform. It includes
general information about the software and the general information about the software and the
project. project.
Some other files to review: The file INSTALL.md has useful instructions on how to
install this software.
- INSTALL: instructions on how to install the software. System administrators may find the DOCUMENTATION/SYSTEM_ADMINISTRATORS
- UPGRADE: upgrading from earlier versions directory useful, namely:
- 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
Information on using GNU social can be found in - upgrade_from: upgrading from different software
the "doc" subdirectory or in the "help" section - CONFIGURE.md: configuration options in gruesome detail.
on-line, or you can catch us on IRC in #social on - PLUGINS.md: how to install and configure plugins.
the freenode network.
Developers may find the DOCUMENTATION/DEVELOPERS directory useful.
## About ## About
@ -39,8 +35,8 @@ mobile phones, instant messenger programs (using
XMPP), and specially-designed desktop clients that XMPP), and specially-designed desktop clients that
support the Twitter API. support the Twitter API.
GNU social supports an open standard called GNU social supports open standards (such as OStatus
OStatus <https://www.w3.org/community/ostatus/> that lets users in <https://www.w3.org/community/ostatus/>) that lets users in
different networks follow each other. It enables a different networks follow each other. It enables a
distributed social network spread all across the distributed social network spread all across the
Web. Web.
@ -97,6 +93,8 @@ liberal terms, but those terms may differ in detail from the AGPL's
particulars. See each package's license file in the extlib directory particulars. See each package's license file in the extlib directory
for additional terms. for additional terms.
Refer to COPYING.md for full text of the software license..
### Troubleshooting ### Troubleshooting
The primary output for GNU social is syslog, The primary output for GNU social is syslog,
@ -117,14 +115,14 @@ to install the development version of GNU social.
To get it, use the git version control tool To get it, use the git version control tool
<http://git-scm.com/> like so: <http://git-scm.com/> like so:
git clone git@git.gnu.io:gnu/gnu-social.git git clone git@notabug.org:diogo/gnu-social.git
In the current phase of development it is probably In the current phase of development it is probably
recommended to use git as a means to stay up to date recommended to use git as a means to stay up to date
with the source code. You can choose between these with the source code. You can choose between these
branches: branches:
- master "stable", more updates, usually working well - master "stable", usually working well
- nightly "unstable", most updates, not always working - nightly "unstable", 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!
@ -135,9 +133,7 @@ There are several ways to get more information about GNU social.
* The #social IRC channel on freenode.net <https://www.freenode.net/>. * 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 unofficial XMPP room linked to IRC on <xmpp:gnusocial@conference.bka.li>
* The GNU social website <https://gnu.io/social/> * The GNU social website <https://gnu.io/social/>
* Following us on GNU social -- <https://quitter.se/gnusocial>
* GNU social has a bug tracker for any defects you may find, or ideas for * GNU social has a bug tracker for any defects you may find, or ideas for
making things better. <https://git.gnu.io/gnu/gnu-social/issues/> making things better. <https://notabug.org/diogo/gnu-social/issues>
* Patches are welcome, preferrably to our repository on git.gnu.io. <https://git.gnu.io/gnu/gnu-social> * Patches are welcome, preferrably to our repository on notabug.org. <https://notabug.org/diogo/gnu-social>