Skip to content
Léon Latour edited this page Apr 13, 2024 · 3 revisions

CINNAMONBEAR Wiki

Welcome to the CINNAMONBEAR Wiki! This wiki contains documentation and guides for using the CINNAMONBEAR peer-to-peer messaging and file transfer software. CINNAMONBEAR only work for computer inside your network, but you should be able to use CINNAMONBEAR through a VLAN (Virtual Local Area Network). For creating a VLAN you should start to check a tools like RadminVPN.

Table of Contents

  1. Introduction
  2. Installation
  3. Usage
  4. Code
  5. Contributing
  6. License

Introduction

CINNAMONBEAR is a simple peer-to-peer messaging and file transfer software built in C++ for Windows. It allows users to communicate and exchange files over a local network without the need for a centralized server.

Installation

To install CINNAMONBEAR, please refer to the Installation Guide.

Usage

Sending Messages

To send a message using CINNAMONBEAR, follow the steps outlined in the Sending Messages Guide.

Sending Files

To send a file using CINNAMONBEAR, follow the steps outlined in the Sending Files Guide.

Receiving Messages

To receive messages using CINNAMONBEAR, follow the steps outlined in the Receiving Messages Guide.

Receiving Files

To receive files using CINNAMONBEAR, follow the steps outlined in the Receiving Files Guide.

Code

You can access the source code of CINNAMONBEAR on GitHub. Follow the instructions below to download or clone the repository to your local machine:

  1. Navigate to the CINNAMONBEAR GitHub repository.
  2. Click on the green "Code" button.
  3. Choose one of the following options:
    • Clone: Copy the URL provided and use Git to clone the repository to your local machine. Use the following command:
      git clone https://github.com/dinde451/CINNAMON-BEAR.git
      
    • Download ZIP: Click on "Download ZIP" to download the repository as a ZIP file. Extract the contents to your desired location.

Once you have downloaded or cloned the repository, you can explore the source code, make modifications, and contribute to the project.

Contributing

Contributions to CINNAMONBEAR are welcome! Please read the Contributing Guidelines before contributing.

License

CINNAMONBEAR is licensed under the Apache License 2.0. See the LICENSE file for details.