warp/INSTALL.md
david 7d75524a8c Removing IDE files and adding them to .gitignore
Upgrade to Rust 2021

- Fix lints
- Formatting pass
- Add Cargo.lock

Use anyhow to improve error handling

Fix errors during directory removal in Windows

Update dependencies

Switch linux build to musl

Switch to musl

Set version to 0.4.0

Allow using uid instead of mtime

Remove name duplication with runner map

Fixing typo

Documentation Update for Cache Location on macOS
Documentation Update for next version of warp-pack and new url for java
Adding support for aarch64 build and needed apple-darwin build options
Using cargo update to get 'newest' dependencies version
Updating warp-packer recursive
First draft of BUILD.md
Fixing several typos in BUILD.md and adding INSTALL.md
Adding section of changes in README.md
Fixing anchor of new section
Fixing typo in README.md
Adding CHANGELOG.md to project
Adding additional information to CHANGELOG.md
Fixing wrong links
Updating information from origin repository
Cleaning up CHANGELOG.md
Updating CHANGELOG.md
Updating version and authors
Fixing links in CHANGELOG.md
Updating CHANGELOG.md for GitHub
2024-05-18 23:31:32 +02:00

83 lines
2.4 KiB
Markdown

# Installation Instructions
Instructions for installing the warp-packer executable on Linux, Mac, and Windows.
## Table of Contents
- [Installation Instructions](#installation-instructions)
- [Table of Contents](#table-of-contents)
- [Linux](#linux)
- [Mac](#mac)
- [Windows](#windows)
## Linux
1. **Copy the warp-packer executable to a directory in your PATH:**
For example, you can copy it to `/usr/local/bin`:
```sh
sudo cp /path/to/warp-packer /usr/local/bin/
```
2. **Ensure the warp-packer executable has the correct permissions:**
Make the file executable:
```sh
sudo chmod +x /usr/local/bin/warp-packer
```
3. **Verify the installation:**
Check that the executable is in your PATH and works correctly:
```sh
warp-packer --version
```
## Mac
1. **Copy the warp-packer executable to a directory in your PATH:**
For example, you can copy it to `/usr/local/bin`:
```sh
sudo cp /path/to/warp-packer /usr/local/bin/
```
2. **Ensure the warp-packer executable has the correct permissions:**
Make the file executable:
```sh
sudo chmod +x /usr/local/bin/warp-packer
```
3. **Verify the installation:**
Check that the executable is in your PATH and works correctly:
```sh
warp-packer --version
```
## Windows
1. **Copy the warp-packer executable to a directory in your PATH:**
For example, you can copy it to `C:\Program Files\warp-packer`:
```powershell
Copy-Item -Path "C:\path\to\warp-packer.exe" -Destination "C:\Program Files\warp-packer\"
```
2. **Add the directory to your PATH environment variable:**
- Open the Start Search, type in "env", and select "Edit the system environment variables".
- In the System Properties window, click on the "Environment Variables..." button.
- In the Environment Variables window, under "System variables", find the `Path` variable, select it, and click "Edit...".
- In the Edit Environment Variable window, click "New" and add the path to the directory where you copied the warp-packer executable (`C:\Program Files\warp-packer\`).
- Click "OK" to close all windows.
3. **Verify the installation:**
Open a new Command Prompt and check that the executable is in your PATH and works correctly:
```cmd
warp-packer --version
```
By following these steps, you will have the warp-packer executable installed and ready to use on Linux, Mac, and Windows.