Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Destray32 authored Oct 28, 2024
1 parent a053a8e commit db0c5a0
Showing 1 changed file with 50 additions and 5 deletions.
55 changes: 50 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,55 @@
## Compilation
# Networking-CPP

To work properly, you must compile code section for host and then for client.
A simple networking project implemented in C++ using the ASIO library. This project demonstrates client-server networking functionalities and includes a sample Hangman game implemented over the network.

----
## Table of Contents

### Information
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)

It should be refactored. Old code, I would put code in appropriate files.
## Features

- **Networking Communication**: Client-server communication using the ASIO library.
- **Sample Game - Hangman**: A classic hangman game implemented for network play.
- **Cross-Platform Compatibility**: Developed in C++ for easy cross-platform support.

## Installation

### Prerequisites

- C++ compiler (C++11 or later)
- CMake
- [ASIO](https://think-async.com/Asio/) (version 1.22.1 included in `Depends` folder)

## Usage

1. **Run the Server**:
- Navigate to the server executable:
```bash
./build/ServerExecutable
```

2. **Run the Client**:
- In a separate terminal, navigate to the client executable:
```bash
./build/ClientExecutable
```

3. **Play the Game**: Follow the on-screen instructions to play Hangman with the server.

## Project Structure

- **ConsoleApplication1/**: Main application folder.
- **Depends/asio-1.22.1/**: ASIO library dependencies.
- **NetworkTest/**: Test files for networking functions.
- **Networking.sln**: Solution file for IDEs like Visual Studio.

## Contribution

Contributions are welcome! Please submit a pull request or open an issue for suggestions.

## License

This project is licensed under the MIT License.

0 comments on commit db0c5a0

Please sign in to comment.