Rust core_dev

Rust core development library (core_dev) is an utility library for rust. It contains a lot of useful functions and APIs to speed up development cycle, which is pretty hard in rust lang.

Table of Contents

• Table of Contents
  • Showcases
  • Install
  • Documentation
  • TODO
  • Contributing
  • Changelog
  • NOTE
  • Extra

Showcases

[dependencies]
crossterm = "0.23"

1. incoming -> incoming
2. incoming -> incoming

Install

1. the modern and simple way

just run this command

cargo add core-dev

and this will add the latest version from crates.io to your Cargo.toml, just like the old way, but automatically.

• what is cargo add ? -> its a cargo sub command
• how to install it ? -> cargo install cargo-edit
• what is cargo-edit ? -> its a rust package that adds useful sub commands for cargo that are not built-in

note that cargo add is built-in from 10.03.2022. see this pull

Documentation

• docs.rs/core-dev
• the-book

Why ?

Because i had one in python and it was very useful. And now because i moved to rust, i also need one in rust.

TODO

check TODO.md

CONTRIBUTING

check CONTRIBUTING.md

Changelog

check CHANGELOG.md

NOTE

Note for the user and developer.

Very early and experimental. im at the same time learning rust, so dont expect very advanced stuff.

if you find issues go ahead and make an issue or a pull request, cant wait to take a look into them.

peace to you!

Frequently Asked Questions (FAQ)

Q: Hosts are not disoverable

A:

• Make sure that no firewall is running (example: ufw), and if that's the case either stop it or add termchat ports to the white list.

• By default you need to allow port 5877/udp and port X/tcp, X is a different with each run. Note that you can specify a custom tcp port as mentioned above and add it to the firewall whitelist.

Q: Hosts are not disoverable

A:

• Make sure that no firewall is running (example: ufw), and if that's the case either stop it or add termchat ports to the white list.

• By default you need to allow port 5877/udp and port X/tcp, X is a different with each run. Note that you can specify a custom tcp port as mentioned above and add it to the firewall whitelist.

Extra

Git Configuration

to apply the settings from .gitconfig of this repo, run this command:

cd rust-python-objects # or dont cd if you are already in
git config --local include.path ../.gitconfig

this needs to run manually because it can never be automated due to security issues, see this stack overflow answer

for git config see also git-config

Badges for readme

https://dev.to/envoy_/150-badges-for-github-pnk