Install and run

Certainly! Here's a revised version with improved wording and clarity while retaining the headers and sections:

Running Mrpack-Changelogger

.Py Script

Note: Ensure that Python 3.10+ is installed.

1. Download the .zip or .tar.gz file from the latest release.

2. Extract the archive and open a terminal in the 'src' folder inside it.

3. Install the dependencies with:

   pip install -r requirements.txt

4. Execute the script.

   python MrpackChangelogger.py [args]

   Example:

   python MrpackChangelogger.py --old_path path/to/old/version --new_path path/to/new/version

Tip

You can also run MrpackChangelogger in your python script!

from MrpackChangelogger import main

# Your code
main(old_path, new_path, config_path, changelog_file)  # Last two are optional

Prebuilt Release

On Windows

1. Navigate to the latest release on GitHub.

2. Download the Windows build from the release tab.

3. Open PowerShell or Command Prompt.

4. Change the directory to where the downloaded file is located.

   cd \path\to\downloaded\file

5. Execute the program.

   .\MrpackChangelogger.exe [args]

On Linux (Deprecated - use the py script)

1. Visit the latest release on GitHub.

2. Download the Linux build from the release tab.

3. Open a terminal.

4. Navigate to the directory containing the downloaded file.

   cd /path/to/downloaded/file

5. Grant execute permissions.

   chmod +x MrpackChangelogger

6. Run the program.

   ./MrpackChangelogger [args]