From 4d76315dc581aec18c3f51156a9a77b11a4ca42e Mon Sep 17 00:00:00 2001 From: Amjad Alsharafi <26300843+Amjad50@users.noreply.github.com> Date: Sat, 19 Oct 2024 15:25:39 +0800 Subject: [PATCH] Update README and added the `installation` section Signed-off-by: Amjad Alsharafi <26300843+Amjad50@users.noreply.github.com> --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 022f978..218ddae 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ This is a personal project for fun and to experience emulating hardware and connecting them together. - [Building and installation](#building-and-installation) - - [Pre-built](#pre-built) + - [Installing](#installing) - [Building](#building) - [Components](#components) - [Interfaces](#interfaces) @@ -36,10 +36,12 @@ This is a personal project for fun and to experience emulating hardware and conn ### Building and installation -#### Pre-built -There are pre-built binaries in the [releases](https://github.com/Amjad50/plastic/releases/latest) tab, -Plastic comes in different *UI*s, one which is the most used normal UI built with [egui] and another one which is a terminal UI (`TUI`) built with [ratatui]. -check [Interfaces](#interfaces) for more details. +#### Installing +You can install the latest version of [plastic](https://crates.io/crates/plastic) or [plastic_tui](https://crates.io/crates/plastic_tui) using cargo: +``` +cargo install plastic +cargo install plastic_tui +``` #### Building If you want to experience the latest development version, you can build `Plastic` yourself.