From e128388d5207263840e2a6cd2bbb6053a2d6b76a Mon Sep 17 00:00:00 2001 From: mik-tf Date: Sat, 12 Oct 2024 09:59:58 -0400 Subject: [PATCH] updated readme --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 52 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5c5509f..42cf3ce 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,11 @@

Table of Contents

- [Introduction](#introduction) -- [Installation](#installation) - - [Prerequisites](#prerequisites) - - [Building and Installing](#building-and-installing) - - [Rebuilding and Uninstalling](#rebuilding-and-uninstalling) +- [Prerequisites](#prerequisites) +- [Makefile Installation](#makefile-installation) + - [Building and Installing with Makefile](#building-and-installing-with-makefile) + - [Rebuilding and Uninstalling with Makefile](#rebuilding-and-uninstalling-with-makefile) +- [Manual Installation](#manual-installation) - [Available Commands](#available-commands) - [Usage](#usage) - [OS-Specific Instructions](#os-specific-instructions) @@ -24,19 +25,20 @@ Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist on the TF Flist Hub, passing through Docker Hub. -## Installation - -### Prerequisites +## Prerequisites - [V programming language](https://vlang.io/) (latest version) installed on your system - [Docker Engine](https://docs.docker.com/engine/install/) installed and running (Linux) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running (MacOS+Windows) - [Docker Hub](https://hub.docker.com/) account - [TF Hub](https://hub.grid.tf/) account and token +- Makefile (optional) Read more on the TF Hub and Flist on the ThreeFold Manual [here](https://manual.grid.tf/documentation/developers/flist/flist.html). -### Building and Installing +## Makefile Installation + +### Building and Installing with Makefile - To clone this repository, build the project, and install the CLI: - MacOS and Linux @@ -54,7 +56,7 @@ Read more on the TF Hub and Flist on the ThreeFold Manual [here](https://manual. This will build the executable and install it to the appropriate system location. -### Rebuilding and Uninstalling +### Rebuilding and Uninstalling with Makefile You can use the following Makefile commands: @@ -78,6 +80,47 @@ You can use the following Makefile commands: make delete-win ``` +## Manual Installation + +You can install the Flist with the following commands. You do not need Makefile to use the Flist CLI. + +- Linux and MacOS + - Build + ``` + v fmt -w flist.v + v -o flist . + sudo ./flist install + ``` + - Rebuild + ``` + sudo flist uninstall + v fmt -w flist.v + v -o flist . + sudo ./flist install + ``` + - Delete + ``` + sudo flist uninstall + ``` +- Windows + - Build + ``` + v fmt -w flist.v + v -o flist . + ./flist.exe install + ``` + - Rebuild + ``` + ./flist.exe uninstall + v fmt -w flist.v + v -o flist . + ./flist.exe install + ``` + - Delete + ``` + ./flist.exe uninstall + ``` + ## Available Commands After installation, you can use the `flist` command followed by various subcommands: