<p align="center">
<a href="https://alexzanderr.github.io/rust-core-dev/book/index.html">
<img src="https://github.com/alexzanderr/rust-core-dev/actions/workflows/deploy_book.yaml/badge.svg" alt="book_deploy">
</a>
<br>
<a href="">
<img src="https://github.com/alexzanderr/rust-core-dev/actions/workflows/vulnerabilities_audit.yaml/badge.svg" alt="vulnerabilities_audit">
</a>
<br>
<a href="https://crates.io/crates/core-dev">
<img src="https://github.com/alexzanderr/rust-core-dev/actions/workflows/crates_io_publish.yaml/badge.svg" alt="crates_io_publish">
</a>
<br>
<a href="https://docs.rs/core-dev/latest">
<img src="https://img.shields.io/badge/docs.rs-core-dev">
</a>
<br>
<a href="https://crates.io/crates/core-dev">
<img src="https://img.shields.io/crates/v/core-dev.svg" alt="Crates.io">
</a>
<br>
<a href="https://choosealicense.com/licenses/mit/" alt="License: MIT">
<img src="https://img.shields.io/badge/license-MIT-green.svg" />
</a>
<br>
<a href="">
<img src="https://img.shields.io/github/stars/alexzanderr/rust-core-dev?style=social">
</a>
<a href="">
<img src="https://img.shields.io/github/forks/alexzanderr/rust-core-dev?style=social">
</a>
<a href="">
<img src="https://img.shields.io/github/watchers/alexzanderr/rust-core-dev?style=social">
</a>
<br>
<a>
<img src="https://img.shields.io/github/repo-size/alexzanderr/rust-core-dev.svg" alt="repo_size">
</a>
<br>
<a href="">
<img src="https://img.shields.io/github/last-commit/alexzanderr/rust-core-dev">
</a>
<a href="">
<img src="https://img.shields.io/github/release-date/alexzanderr/rust-core-dev">
</a>
<br>
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/badge/rustc-1.60+-yellow?logo=rust">
</a>
<br>
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/crates/d/python-objects">
</a>
<br>
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/maintenance/yes/2022">
</a>
<br>
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/github/contributors/alexzanderr/rust-core-dev">
</a>
<br>
<a href="https://www.rust-lang.org">
<img src="https://img.shields.io/crates/l/python-objects.svg">
</a>
</p>
# 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](#table-of-contents)
- [Showcases](#showcases)
- [Install](#install)
- [Documentation](#documentation)
- [TODO](#todo)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [NOTE](#note)
- [Extra](#extra)
# Showcases
<details>
<summary>
Click to show Cargo.toml.
</summary>
```toml
[dependencies]
crossterm = "0.23"
```
</details>
1. [`incoming`] -> incoming
2. [`incoming`] -> incoming
# Install
### 1. the modern and simple way
just run this command
```shell
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`](https://github.com/killercup/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`](https://github.com/rust-lang/cargo/pull/10472)
# Documentation
- [`docs.rs/core-dev`](https://docs.rs/core-dev/latest)
- [`the-book`](https://alexzanderr.github.io/rust-core-dev/index.html)
# 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`](https://github.com/alexzanderr/rust-core-dev/blob/main/TODO.md)
# CONTRIBUTING
check [`CONTRIBUTING.md`](https://github.com/alexzanderr/rust-core-dev/blob/main/CONTRIBUTING.md
)
# Changelog
check [`CHANGELOG.md`](https://github.com/alexzanderr/rust-python-objects/blob/main/changelog/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`](https://github.com/alexzanderr/rust-python-objects/issues/new)
or a
[`pull request`](https://github.com/alexzanderr/rust-python-objects/compare),
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:
```shell
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`](https://stackoverflow.com/a/18330114/12172291)
for git config see also [`git-config`](https://git-scm.com/docs/git-config#_includes)
## Badges for readme
https://dev.to/envoy_/150-badges-for-github-pnk