Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lexz-08 authored Oct 2, 2022
1 parent abb7d54 commit 41a1cc3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CDL-Crosshair-Installer
## Description
Makes adding images or image sets to Custom-Desktop-Logo easier.

## How To Setup a .ZIP for Installation
To make a .ZIP with the image files, install [7-zip](https://www.7-zip.org/) or [WinRAR](https://www.win-rar.com/) and select the files in your folder then select whichever option for either program that compresses the files.
If you do compress a folder, then the images will not be found by **CustomDesktopLogo**.

## CLI Is Supported
To use the ***cli***, enter the arguments like this (both are optional, but the image set must be entered first if you want to use the second argument):<br/><br/>
Syntax: `"<IMAGE_SET_PATH>" -clean`

Rules:
* `IMAGE_SET_PATH`: The file path to your .ZIP file.
* `-clean`: Specifies that the program must delete the original archive file after extracting the contents to the **Images** folder.

## Download
[Standalone](https://github.com/Lexz-08/CDL-Crosshair-Installer/releases/latest/download/CDL-Crosshair-Installer.zip)<br/>
[Installer](https://github.com/Lexz-08/CDL-Crosshair-Installer/releases/latest/download/Installer.zip)

0 comments on commit 41a1cc3

Please sign in to comment.