📦 Table of Contents

• 📦 Table of Contents
• 📝 Todo
• 📂 Installation
  • 😎 Posix Users (Linux, MacOS, etc)
  • 🪟 Windows Users
• 🏃 Usage
  • 🔨 Basic Usage
    • 😎 Posix Users
    • 🪟 Windows Users
  • 🔧 Config
    • 🗔 Specifying a Resolution
    • ⏲ Specifying a Timeout
    • 🧰 Using a custom template
    • 📤 Output and Save Options
• 📜 License

📝 Todo

• Add a way to specify a template file
• Add Emojis to README
• Add a way to specify a resolution
• Implement a way to specify a background color
• Add more todo items

📂 Installation

Make sure git (and base-devel-equivalents) is installed

• Arch: sudo pacman -S git base-devel
  
• Ubuntu: sudo apt install git build-essential
  
• MacOS: brew install git
  
• Windows: git-scm.com/download/win

Additionally, make sure PNPM is installed.

• All POSIX: curl -fsSL https://get.pnpm.io/install.sh | sh -
• Windows: iwr https://get.pnpm.io/install.ps1 -useb | iex

As with any software, make sure you trust the source before running any commands.

😎 Posix Users (Linux, MacOS, etc)

# Clone the repository
git clone [email protected]:Exponential-Workload/imgtool.git ~/imgtool;
# Enter the repository
cd ~/imgtool;
# Run install script
./install.sh;

🪟 Windows Users

cd %USERPROFILE%
git clone git@github.com:Exponential-Workload/imgtool.git imgtool;
cd imgtool;
pnpm i;
pnpm build;

🏃 Usage

🔨 Basic Usage

😎 Posix Users

imgtool
# in development, use 'pnpm dev' in the repo's directory instead.

🪟 Windows Users

cd %USERPROFILE%\imgtool;
pnpm start
@REM for development, use 'pnpm dev' instead

🔧 Config

🗔 Specifying a Resolution

Add

--res 1920x1080

to your arguments.

⏲ Specifying a Timeout

Add

--timeout 1000

to your arguments. This will make the CLI wait 1000ms before taking the screenshot, to ensure the background has loaded.

🧰 Using a custom template

Make a file similar to the template.html in this repository in the folder you run the CLI in, and it will use that.

📤 Output and Save Options

Saving to a Specific Path Add:

--output path/to/save/image.png This will save the generated image to the specified path.

Opening the Generated Image

To automatically open the generated image after it's created, use: --open

📜 License

Copyright (c) 2023 Nexus Networks.
Licensed under the MIT License.