Skip to content

Latest commit

 

History

History
125 lines (89 loc) · 4.65 KB

README.md

File metadata and controls

125 lines (89 loc) · 4.65 KB
Raw

Latest Release

C++

English Readme | 中文自述文件

A powerful application to automatically deploy GitHub Release.

Features

Highly automated processes

  • Includes auto-unzip and auto-clean features
  • Automatic installation feature is under development

Simple yet powerful configuration solutions

  • Requires only one configuration and can be used all the time
  • Hot update support for configuration files

Install

There are many ways for you to install this program.

Run the script though exe file

Only for Windows user.

  1. Turn to GitHub Releases Page, then click on Assets at the bottom to show the files available in the release.
  2. Download the Latest Release.zip file and decompress it.
  3. Create the config.yaml file and then configure it by referencing to the Usage in README.md.
  4. Run the exe file though Command Window.

Run the script though Python

This approach requires you to install Python3 into your desktop first.

  1. Turn to GitHub Releases Page, then click on Assets at the bottom to show the files available in the release.
  2. Download the Source code (zip) and decompress it.
  3. Create the config.yaml file and then configure it by referencing to the Usage in README.md.
  4. Install the package the scripts need.
  5. Run the main.py file.

Usage

Commands

After start the exe file, you can enter help in the Command Windows to see the commands with their description.

    Command[<args>]        :           Usage
    list/ls                :           List installed apps
    status/st              :           Show status and check for new app versions
    update/up              :           Update all apps
    config/cf              :           Open config file to add an app or modify other settings
    exit/et                :           Exit the shell

How to Configure the config.yaml file

A simplest config.yaml file is shown like this:

path: download
proxy:
  http: http://127.0.0.1:7890
  https: http://127.0.0.1:7890
repos:
  - author: Fentaniao
    name: Liquid
    tag: 
    key: Liquid.zip
    target: 
    setting: { decompress: auto, clean: true }

Parameters

Parameter Type Default Description
path str - Default storage path, automatically stored under path if target is not specified
proxy dict - Proxy Information
repos dict - Repository Information

reposRepository Information

Parameter Type Default Description
author str - Repository Owner
name str - Repository Name
tag str - tag of Release
key str "all" Name of the file to be downloaded
target str path Path to download file
setting dict { decompress: auto, clean: true } Decompression settings

settingDetail Settings

Parameter Type Default Description
decompress str - Decompression method, auto means automatically decompress, other non-empty str means install in the same name directory, put empty then decompress to file_name + '_files' directory
clean str true true means the zip file will be cleaned up automatically after decompression is completed

Roadmap

  • A client with a GUI based on WinUI3 is coming soon.
  • Support more functions and more ways of configuration.

Contact

Author: Fentaniao

Email: [email protected]

License

GPL-3.0 License © Fentaniao