updated readme with 3 os steps

This commit is contained in:
mik-tf 2024-10-03 03:01:05 -04:00
parent 25901d9f8c
commit 9f4d33f8fc

View File

@ -10,8 +10,9 @@
- [Usage](#usage)
- [Commands](#commands)
- [OS-Specific Instructions](#os-specific-instructions)
- [Linux](#linux)
- [macOS](#macos)
- [Windows](#windows)
- [macOS and Linux](#macos-and-linux)
- [Troubleshooting](#troubleshooting)
- [Development](#development)
- [Contributing](#contributing)
@ -80,17 +81,7 @@ flist <command> [arguments]
## OS-Specific Instructions
### Windows
1. Run Command Prompt or PowerShell as Administrator.
2. Ensure Docker Desktop is installed and running.
3. Use a Docker-enabled terminal for all Docker-related commands.
4. The `flist` executable will be installed to:
```
C:\Program Files\flist\flist.exe
```
### macOS and Linux
### Linux
1. Ensure Docker is installed and the Docker daemon is running.
2. The `flist` executable will be installed to:
@ -98,6 +89,18 @@ flist <command> [arguments]
/usr/local/bin/flist
```
### macOS
1. Ensure Docker Desktop is installed and running.
2. The `flist` executable will be installed to:
```
/usr/local/bin/flist
```
### Windows
For now, we recommend to use WSL and follow the Linux steps.
## Troubleshooting
- If you encounter permission issues, ensure you're running the command with appropriate privileges (e.g., as administrator on Windows or with `sudo` on Unix-like systems).