Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
beautify(readme): installation guide , docx
- Loading branch information
Showing
1 changed file
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
<div align="center"> | ||
<a href="https://github.com/pwnwriter/rustycli"> | ||
<img src="https://github.com/pwnwriter/rustycli/blob/images/rustycli-crop.gif" width="300" style="border-radius: 50%;"> | ||
</a> | ||
|
||
<h4><strong><code>rustycli</code></strong> — 🦀 Access the rust playground right in terminal 🍥</h4> | ||
<a href="https://github.com/pwnwriter/rustycli/releases"><img src="https://img.shields.io/github/v/release/pwnwriter/rustycli?style=flat&labelColor=56534b&color=c1c1b6&logo=GitHub&logoColor=white" alt="GitHub Release"></a> | ||
<a href="https://crates.io/crates/rustycli/"><img src="https://img.shields.io/crates/v/rustycli?style=flat&labelColor=56534b&color=c1c1b6&logo=Rust&logoColor=white" alt="Crate Release"></a> | ||
<a href="https://github.com/pwnwriter/haylxon/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-white.svg" alt="MIT LICENSE"></a> | ||
<a href="https://twitter.com/intent/tweet?text=Check%20out%20rustycli%20-%20An%20exceptional%20tool%20that%20allows%20you%20to%20access%20the%20Rust%20Playground%20right%20in%20the%20terminal%20without%20limitations!%20🚀%20&url=https%3A%2F%2Fgithub.com%2Fpwnwriter%2Frustycli"><img alt="Twitter Share" src="https://img.shields.io/twitter/url/https/github.com/pwnwriter/rustycli.svg?style=social"></a> | ||
|
||
[![ko-fi](https://img.shields.io/badge/support-pwnwriter%20-pink?logo=kofi&logoColor=white)](https://ko-fi.com/pwnwriter) | ||
</div> | ||
|
||
<br> | ||
|
||
[`rustycli`](https://github.com/pwnwriter/rustycli) is a tool, allowing you to access the [`rust playground`](https://play.rust-lang.org/) right in the terminal and retaining all the features available on the web version. | ||
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png) | ||
|
||
|
||
|
||
<a name="installation"></a> | ||
## Installation 📩 | ||
|
||
- **Binary**: | ||
You can directly download [`binary`](https://github.com/pwnwriter/rustycli/releases/) of your arch and run it. | ||
|
||
- **Source**: | ||
|
||
```bash | ||
$ git clone --depth=1 https://github.com/pwnwriter/rustycli --branch=main | ||
$ cd rustycli | ||
$ cargo build --release | ||
``` | ||
Then go to `release` dir and `./rustycli` or move the `binary` to your any `$PATH` for instant access from anywhere. | ||
|
||
- **Cargo**: | ||
```bash | ||
$ cargo install rustycli | ||
``` | ||
|
||
|
||
- **Aur**: | ||
```bash | ||
$ paru/yay -Sy rustycli | ||
``` | ||
|
||
- **[METIS Linux](https://metislinux.org) (based)**: | ||
``` | ||
$ sudo/doas pacman -Syyy rustycli | ||
``` | ||
![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png) | ||
|
||
|
||
|
||
|
||
<a name="usages"></a> | ||
## Usages 🎠 | ||
- Everything is under help menu. The most required flag is `-r` or `--run` to pass your code. The below is a small demo ❤️🩹 | ||
|
||
https://github.com/pwnwriter/rustycli/assets/90331517/2f5b6d1b-e4eb-4f63-8610-6caccdfc13b0 | ||
|
||
|
||
|
||
|
||
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p> | ||
<p align="center">Copyright © 2023<a href="https://pwnwriter.xyz" target="_blank"> pwnwriter xyz ☘️ </a> | ||
|