updated readme and makefile

This commit is contained in:
mik-tf 2024-10-02 12:36:57 -04:00
parent 9392acb22e
commit 3bfb44099d
2 changed files with 22 additions and 16 deletions

View File

@ -7,6 +7,7 @@ rebuild:
sudo flist uninstall sudo flist uninstall
v -o flist . v -o flist .
sudo ./flist install sudo ./flist install
delete: delete:
sudo rm flist sudo rm flist
sudo flist uninstall sudo flist uninstall

View File

@ -6,7 +6,7 @@
- [Installation](#installation) - [Installation](#installation)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Building and Installing](#building-and-installing) - [Building and Installing](#building-and-installing)
- [Rebuild Locally](#rebuild-locally) - [Rebuild and Uninstall](#rebuild-and-uninstall)
- [Usage](#usage) - [Usage](#usage)
- [OS-Specific Instructions](#os-specific-instructions) - [OS-Specific Instructions](#os-specific-instructions)
- [Windows](#windows) - [Windows](#windows)
@ -33,23 +33,28 @@ Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist
### Building and Installing ### 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 git clone https://git.ourworld.tf/tfgrid/flist_cli_v
cd flist-cli cd flist_cli_v
v -o flist . make build
sudo ./flist install
``` ```
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:
``` - To rebuild and reinstall:
make build ```
``` make rebuild
```
- To uninstall and remove the binary:
```
make delete
```
## Usage ## Usage
@ -90,9 +95,9 @@ Available commands:
``` ```
3. You may need to use `sudo` for installation and certain operations: 3. You may need to use `sudo` for installation and certain operations:
``` ```
sudo ./flist install sudo make build
sudo flist uninstall sudo make rebuild
sudo flist <command> sudo make delete
``` ```
## Troubleshooting ## Troubleshooting
@ -107,7 +112,7 @@ Available commands:
To modify the Flist CLI: To modify the Flist CLI:
1. Make your changes to the `flist.v` file. 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. 3. Test your changes thoroughly across different operating systems if possible.
## Contributing ## Contributing