updated readme and makefile
This commit is contained in:
parent
9392acb22e
commit
3bfb44099d
1
Makefile
1
Makefile
@ -7,6 +7,7 @@ rebuild:
|
||||
sudo flist uninstall
|
||||
v -o flist .
|
||||
sudo ./flist install
|
||||
|
||||
delete:
|
||||
sudo rm flist
|
||||
sudo flist uninstall
|
43
README.md
43
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,24 +33,29 @@ 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:
|
||||
```
|
||||
git clone https://github.com/yourusername/flist-cli.git
|
||||
cd flist-cli
|
||||
v -o flist .
|
||||
sudo ./flist install
|
||||
```
|
||||
|
||||
This will copy the `flist` executable to the appropriate system location.
|
||||
|
||||
### Rebuild Locally
|
||||
|
||||
You can use the Makefile command to uninstall and reinstall the binary:
|
||||
|
||||
1. Clone this repository, build the project, and install the CLI:
|
||||
```
|
||||
git clone https://git.ourworld.tf/tfgrid/flist_cli_v
|
||||
cd flist_cli_v
|
||||
make build
|
||||
```
|
||||
|
||||
This will build the `flist` executable and install it to the appropriate system location.
|
||||
|
||||
### Rebuild and Uninstall
|
||||
|
||||
You can use the following Makefile commands:
|
||||
|
||||
- To rebuild and reinstall:
|
||||
```
|
||||
make rebuild
|
||||
```
|
||||
|
||||
- To uninstall and remove the binary:
|
||||
```
|
||||
make delete
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
After installation, you can use the `flist` command followed by various subcommands:
|
||||
@ -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 <command>
|
||||
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
|
||||
|
Loading…
Reference in New Issue
Block a user