Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing

About The Project

[]

The rustorrent binary is a command line tool to create a Bitorrent client.

Getting Started

Prerequisites

You obviously need rust installed on your machine to compile our CLT, please read the official installation tutorial

Running as a client

1. Clone the repository

   git clone https://github.com/epita-rs/Rustorrent.git

2. Launch the client

   cargo run --release

Running as a seeder

blabla

Roadmap

• [ 1 ] Bencoding / decoding
• [ 2 ] File Management
• [ 3 ] Network

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request