Giter Site home page Giter Site logo

sardinburk's Introduction

Sardinburk

Sardinburk is a direct chat application between several devices. Sardinburk is made in Rust. Sardinburk allows for users to have a nickname and communicate both locally and world-wide. See the usage section below.

Disclaimer: Sardinburk is not meant to be reliable. It's meant to be simple! If you're looking for any kind of security, reliability, or really anything, I'll link a better program here when it's available!

Table of Content

Installation

If you don't want to compile the thing yourself, download the latest release here.

If you instead want to compile Sardinburk, you can do so by getting Rust. Once that is installed, clone the repository: git clone [email protected]:Mnpn03/Sardinburk.git to clone with SSH, or git clone https://github.com/Mnpn03/Sardinburk.git to clone with HTTPS. Then you simply build it by running cargo build --release.

Usage

$ sardinburk --help
=> sardinburk...
$ sardinburk 127.0.0.1 --name John
=> Hello world, John! You're the user with ID 2...
$ sardinburk --name Martin
=> Hello world, Martin! Others can join you by providing...

Supply an IP to connect to it, otherwise you're the host!

Contribution

To contribute to the project, simply create a Pull Request or an Issue.

If you want to create an Issue, please clearly state the bug and/or ways to replicate it (if it's a bug/glitch/exploit).

If you want to create a Pull Request, please clearly state what you've changed and if it has resolved an issue, and if so - which one.

Following these short guidelines will make it easier and faster for your Issue/Pull Request to be reviewed and dealt with. Thanks!

License

Sardinburk is FOSS that comes with no warranty. Read more about the license used here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.