From 3bfb44099d455406769ab1d8eaef0b3c3e5d7c78 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Wed, 2 Oct 2024 12:36:57 -0400 Subject: [PATCH] updated readme and makefile --- Makefile | 1 + README.md | 37 +++++++++++++++++++++---------------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/Makefile b/Makefile index cda3e4d..25f215a 100644 --- a/Makefile +++ b/Makefile @@ -7,6 +7,7 @@ rebuild: sudo flist uninstall v -o flist . sudo ./flist install + delete: sudo rm flist sudo flist uninstall \ No newline at end of file diff --git a/README.md b/README.md index 2922809..6495af3 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ - [Installation](#installation) - [Prerequisites](#prerequisites) - [Building and Installing](#building-and-installing) - - [Rebuild Locally](#rebuild-locally) + - [Rebuild and Uninstall](#rebuild-and-uninstall) - [Usage](#usage) - [OS-Specific Instructions](#os-specific-instructions) - [Windows](#windows) @@ -33,23 +33,28 @@ Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist ### Building and Installing -1. Clone this repository, build the project, run the install command and set the CLI to your path: +1. Clone this repository, build the project, and install the CLI: ``` - git clone https://github.com/yourusername/flist-cli.git - cd flist-cli - v -o flist . - sudo ./flist install + git clone https://git.ourworld.tf/tfgrid/flist_cli_v + cd flist_cli_v + make build ``` - This will copy the `flist` executable to the appropriate system location. + This will build the `flist` executable and install it to the appropriate system location. -### Rebuild Locally +### Rebuild and Uninstall -You can use the Makefile command to uninstall and reinstall the binary: +You can use the following Makefile commands: -``` -make build -``` +- To rebuild and reinstall: + ``` + make rebuild + ``` + +- To uninstall and remove the binary: + ``` + make delete + ``` ## Usage @@ -90,9 +95,9 @@ Available commands: ``` 3. You may need to use `sudo` for installation and certain operations: ``` - sudo ./flist install - sudo flist uninstall - sudo flist + sudo make build + sudo make rebuild + sudo make delete ``` ## Troubleshooting @@ -107,7 +112,7 @@ Available commands: To modify the Flist CLI: 1. Make your changes to the `flist.v` file. -2. Rebuild the project using `v -o flist .` +2. Rebuild the project using `make rebuild` 3. Test your changes thoroughly across different operating systems if possible. ## Contributing