Skip to content

Commit

Permalink
Bring the README up-to-date in content and formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
genius3000 committed Apr 7, 2020
1 parent 7e86cb1 commit 1f6d7c8
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 21 deletions.
21 changes: 0 additions & 21 deletions README

This file was deleted.

51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## About

InspIRCd is a modular C++ Internet Relay Chat (IRC) server for UNIX-like and Windows systems.

This repository contains additional modules contributed and maintained by the users of InspIRCd.

## Installation

The primary interface to this repository is via the `modulemanager` binary shipped with InspIRCd.

If you do not have this or do not wish to use it, you can download directly from this repository.

Copy or symlink the modules you wish to use to src/modules/ in the InspIRCd directory.

Then just rerun `make` and `make install`.

## Support

Modules in this repository are not officially supported by the InspIRCd development team.

See the module author comments in the module files to find the author.

You may be able to find the author or others who use the module in [\#inspircd on irc.inspircd.org](https://kiwiirc.com/nextclient/irc.inspircd.org:+6697/#inspircd).

Please make it clear you're asking about a contrib module!

## Development

### 3.x Example tags:

```
/// $ModAuthor: w00t
/// $ModAuthorMail: [email protected]
/// $ModConfig: <syncbans channels="#a,#b,#c">
/// $ModConflicts: m_muteban.so
/// $ModDepends: core 3
/// $ModDesc: Provides ircd-side fantasy commands.
/// $ModMask: mask reason (e.g., deprecated or obsolete)
```

### 2.0 Example tags:

```
/* $ModAuthor: w00t */
/* $ModAuthorMail: [email protected] */
/* $ModConfig: <syncbans channels="#a,#b,#c"> */
/* $ModConflicts: m_muteban.so */
/* $ModDepends: core 2.0 */
/* $ModDesc: Provides ircd-side fantasy commands. */
/* $ModMask: mask reason (e.g., deprecated or obsolete) */
```

0 comments on commit 1f6d7c8

Please sign in to comment.