Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Updated main README.md and created portable README.txt document
  • Loading branch information
neuralpain committed Aug 4, 2024
1 parent c3a0b42 commit bdafa76
Show file tree
Hide file tree
Showing 2 changed files with 383 additions and 27 deletions.
110 changes: 83 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<picture><img src="./assets/images/oneclickwinrar-header@2x.png" alt="oneclickwinrar header"></picture>
<picture><img src="./assets/images/oneclickwinrar-header.jpg" alt="oneclickwinrar header"></picture>
</p>

# oneclickwinrar - install and license WinRAR
Expand All @@ -8,22 +8,48 @@
there was a need for something versatile // so why not?
```

- `oneclickrar.cmd` - download, install/update and license WinRAR *(recommended for most users)*
- `installrar.cmd` - download and install WinRAR without licensing it (or just update if already installed)
- `licenserar.cmd` - license WinRAR, if already installed

> [!NOTE]
> `oneclickwinrar` refers to this project and everything that comes with it. On the other hand, `oneclickrar.cmd` (notice there's no "win" in the name) is a script within the project. Don't mix them up.
## what's included? (click on the links to download)

### [oneclickrar.cmd](https://github.com/neuralpain/oneclickwinrar/releases/latest/download/oneclickrar.cmd) *(recommended for most users)*

The one click you need to rule them all. Download, install, update and license WinRAR, all in just one single click (or double). Yes, it's that simple.

### [installrar.cmd](https://github.com/neuralpain/oneclickwinrar/releases/latest/download/installrar.cmd)

Just need to install WinRAR or just update if it's already installed? Here's a script for that. No need to download it yourself. Let `installrar` take care of that for you. Download and install WinRAR without licensing it.

### [licenserar.cmd](https://github.com/neuralpain/oneclickwinrar/releases/latest/download/licenserar.cmd)

C'mon, you've been using WinRAR unlicensed for years. Just get a license and be done with that that infinite 40-day trial. (You can also use this script to install a license that you purchased directly from WinRAR.)

### [unlicenserar.cmd](https://github.com/neuralpain/oneclickwinrar/releases/latest/download/unlicenserar.cmd)

A stitch in time saves nine.

> [!TIP]
> Get the full package from the [releases page](https://github.com/neuralpain/oneclickwinrar/releases/latest). It includes everything you need for customization.
>
> - Will automatically download the latest English WinRAR (64-bit) installer
> - Can install and license ANY version available in the current directory
> - WinRAR is installed at `C:\Program Files\WinRAR` for 64-bit operating systems and `C:\Program Files (x86)\WinRAR` for 32-bit operating systems
> - Check the releases page for downloads (or download from the repository; whichever you prefer)
> Yes, customization. Read further down past the "features" and the "how to's" for the customization section. It might get a bit "technical".
## features

- Install and license ANY version of WinRAR
- Automatically downloads and installs the latest English WinRAR (64-bit) installer
- Supports downloading and installing WinRAR through modification of the script name
- Create custom licenses for your personal use
- Remove WinRAR licenses (for whatever reason)

> [!NOTE]
> `oneclickwinrar` will not overwrite existing licenses unless explicitly told to do so.
## how to use
# how to use

1. Download the latest release from the releases page
1. Download the latest release from the releases page (or use what you downloaded from above)
2. Extract the contents of the zip file to a directory of your choice
3. Add a WinRAR executable to the directory (or update an existing one), if necessary
3. Add a WinRAR executable to the directory, if necessary
4. Customize and/or run the script you want to use

> [!IMPORTANT]
Expand All @@ -33,31 +59,34 @@ there was a need for something versatile // so why not?

There are two types of customization:

1. **Partial customization**, which is either custom licensing, or custom downloading
2. **Complete customization**, which is both custom licensing and download
1. **Partial customization**, which is either custom licensing, or custom install
2. **Complete customization**, which is both custom licensing and install

There are five (5) parts to the customization process:

- `licensee`: This is "you" or whatever name you want to use
- `license_type`: The description of license that you want to install
- `architecture`: The architecture of the WinRAR executable (eg. x64, x86)
- `version`: The version of the WinRAR executable without any periods `"."` (eg. 590, 701)
- `tags`: **This is optional.** These are additional tags, usually found at the end of the WinRAR executable name, used to describe the language of the executable and whether or not it is a beta release.
- `architecture`: The architecture of the WinRAR executable (eg. x64, x32)
- `version`: The version of the WinRAR executable without any periods `"."` (eg. 590, 701). **This is optional.**
- `tags`: These are additional tags, usually found at the end of the WinRAR executable name, used to describe the language of the executable and whether or not it is a beta release. **This is optional.**

> [!WARNING]
> The `script_name` is the name of the script file [oneclickrar, licenserar, installrar] that you use to install and/or license WinRAR. Do not change the `script_name`.
> The `script_name` is the name of the script file [oneclickrar, licenserar, installrar] that you use to install and/or license WinRAR. Do not modify the `script_name` unless you want to [overwrite licenses](#overwriting-licenses).
## naming patterns

### complete naming pattern [oneclickrar.cmd]
> [!NOTE]
> If you don't see a `.cmd` extension in the file name, **do not add it**. This just means that you have `"Show file name extensions"` disabled in Windows Explorer. No, **you do not need to enable it**. Just continue customizing the script without adding the extension.
### complete naming pattern (supported by oneclickrar.cmd)

```
<licensee>_<license_type>_<script_name>_<architecture>_<version>_<tags>.cmd
Example: My Name_My License_oneclickrar_x64_601.cmd
Example: My Name_My License_oneclickrar_x64_700.cmd
```

### licensing-only pattern [licenserar.cmd, oneclickrar.cmd]
### licensing-only pattern (supported by licenserar.cmd, oneclickrar.cmd)

When setting up custom licensing, you must only add information ***BEFORE*** the `script_name`.

Expand All @@ -67,29 +96,56 @@ When setting up custom licensing, you must only add information ***BEFORE*** the
Example: My Company_My Company License_licenserar.cmd
```

### downloading-only pattern [installrar.cmd, oneclickrar.cmd]
### install-only pattern (supported by installrar.cmd, oneclickrar.cmd)

When setting up custom downloading, you must only add information ***AFTER*** the `script_name`.
When setting up custom install, you must only add information ***AFTER*** the `script_name`.

```
<script_name>_<architecture>_<version>_<tags>.cmd
Example: installrar_x64_601.cmd
Example: installrar_x64_700ru.cmd // Russian language
```

> [!CAUTION]
> Underscores `"_"` are primarily used for data separation and **should not** be used in license information or download data.
> [!IMPORTANT]
> * `installrar.cmd` is for installation only. It does not support custom licenses.
> * `licenserar.cmd` is for licensing only. It does not support custom downloading.
> * `licenserar.cmd` is for licensing only. It does not support custom install.
> * Spaces are allowed in the `licensee` and `license_type` names.
> * The different data must be separated by an underscore.
> * The `licensee` and `license_type` will be displayed exactly as you type them.
> * `unlicenserar.cmd` is for removing licenses only. It cannot be customized.
> [!TIP]
> You can use as many underscores as you want. The example below is valid.
> You can use as many underscores as you want to separate the data, if it will help you read it better. The example below is valid.
> ```
> My Name____My License__oneclickrar________x64_601.cmd
> My Name____My License__oneclickrar________x64_700.cmd
> ```
## overwriting licenses
Information pertaining to overwriting licenses is in it's own section because it's a bit different (not that much different) and there are some people out there in the world who may, for one reason or another, happen to miss it.
Overwriting is only supported by `oneclickrar.cmd` and `licenserar.cmd`.
To enable overwriting licenses, you must edit the script's file name to have a hyphen `"-"` just before the `"rar"` so that it becomes `"-rar"`. This is a very simple switch. Errors of any nature will bring shame upon the spring-loaded keys on your 1987 IBM Model M 1391401 White Label keyboard.
Follow the examples below to see how it works.
```
# very simple
oneclick-rar.cmd
```
```
# so simple
Overwrite_ThisLicense_license-rar.cmd
```
```
# more practical
John Doe_Unlimited Lifetime License_oneclick-rar_x64_701.cmd
```
# License
```
Expand Down
Loading

0 comments on commit bdafa76

Please sign in to comment.