Skip to content

Commit

Permalink
Create README.md (HelloThere-ImMat#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
romann-broque authored Jan 6, 2024
1 parent 7fd1ca2 commit e921977
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 48 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## ft_irc

### 🗺️ Project Overview
The ft_irc project involves building an IRC server. The server manages connections between clients, facilitates communication, and handles user interactions within channels. Clients connect to the server to join channels, exchange messages, and interact with other users.

### 🌟 Key Features
Server-Client Architecture: Implements a server-client model for managing connections and facilitating communication between users.

IRC Protocol: Adheres to the IRC protocol for handling client-server interactions, commands, and message formats.

Multiple Channels: Supports the creation and management of multiple chat channels where users can join, send messages, and interact.

User Authentication: Implements user authentication to ensure secure access to the server and channel communication.

Command Handling: Processes various IRC commands that users can send to the server to perform actions, here the list:

- NICK (set the nickname of the user)
- PRIVMSG (send messages to client(s) or channel(s))
- TOPIC (set the topic of a channel)
- INVITE (invite specific user for joining a channel)
- KICK (kick specific user from a channel)
- MODE (only for channels) :
- i (set/unset invite-only)
- k (set/unset password)
- l (set/unset user limit)
- o (set/unset a user as operator)
- t (set/unset topic restriction)

### 🚀 How to Use
To compile and run the ft_irc server and client, follow these steps:

#### Compilation:

```shell
make
```

#### Start Server:

```shell
./ircserv [port] [password]
```

Replace [port] with the port number on which the server will listen for incoming connections and [password] with the password that clients will need to enter to connect to it.

It is recommended to use irssi.
16 changes: 0 additions & 16 deletions clientLog

This file was deleted.

32 changes: 0 additions & 32 deletions ownerlog

This file was deleted.

0 comments on commit e921977

Please sign in to comment.