From 62d7198359e66e140ea7918d6fd128619f0f6039 Mon Sep 17 00:00:00 2001 From: StardustDL Date: Sat, 27 Jun 2020 09:24:38 +0800 Subject: [PATCH] update readme --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45d6eaf..37e37ad 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ ![CI](https://github.com/StardustDL/ImagingS/workflows/CI/badge.svg) -![](https://repository-images.githubusercontent.com/226446069/543f5900-b6f2-11ea-8f2a-47095902e2bd) +![](https://repository-images.githubusercontent.com/226446069/77831900-b856-11ea-95ef-6fd6c38a9edc) A toolset for computer graphics and imaging processing. -[Demo Video](https://www.bilibili.com/video/BV1Q54y1i7Lg/) +- [Demo Video](https://www.bilibili.com/video/BV1Q54y1i7Lg/) +- [Usage 中文](https://github.com/StardustDL/own-staticfile-hosting/tree/0eb7357813c8f043e5bc6c488e4fe2c971a87424/StardustDL/ImagingS/Helping) ## Features @@ -33,6 +34,33 @@ A toolset for computer graphics and imaging processing. - Export - PNG, JPEG, BMP +## Usage + +1. Clone this repository. +2. Install dependencies. + +```sh +pip install requirements.txt +``` + +3. Generate UI codes + +```sh +python -m ImagingS.Gui.uic +``` + +4. Run GUI + +```sh +python -m ImagingS.Gui +``` + +5. Run CLI + +```sh +python -m ImagingS.Cli input.txt output_dir +``` + # License All rights reserved.