{"id":26585156,"url":"https://github.com/mzdk100/rigela","last_synced_at":"2025-04-06T12:07:20.990Z","repository":{"id":217378304,"uuid":"743708176","full_name":"mzdk100/rigela","owner":"mzdk100","description":"这是一个使用纯Rust编写的读屏（Screen Reader）项目，用于视力有障碍的人群操作电脑，软件会将屏幕上的各种信息转换成语音输出。","archived":false,"fork":false,"pushed_at":"2025-01-19T03:13:34.000Z","size":13637,"stargazers_count":166,"open_issues_count":1,"forks_count":7,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-30T11:06:16.231Z","etag":null,"topics":["a11y","accessibility","blind","ia2","iaccessible2","jab","java-access-bridge","msaa","nvda","rsr","rust","screen-reader","talkback","ui-automation"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mzdk100.png","metadata":{"files":{"readme":"README-EN.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T20:14:20.000Z","updated_at":"2025-03-17T13:50:13.000Z","dependencies_parsed_at":"2024-02-07T12:26:10.780Z","dependency_job_id":"4419a1be-6d82-4223-95d1-5180d88537d1","html_url":"https://github.com/mzdk100/rigela","commit_stats":null,"previous_names":["mzdk100/rigela"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mzdk100%2Frigela","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mzdk100%2Frigela/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mzdk100%2Frigela/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mzdk100%2Frigela/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mzdk100","download_url":"https://codeload.github.com/mzdk100/rigela/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478318,"owners_count":20945266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","accessibility","blind","ia2","iaccessible2","jab","java-access-bridge","msaa","nvda","rsr","rust","screen-reader","talkback","ui-automation"],"created_at":"2025-03-23T10:30:57.612Z","updated_at":"2025-04-06T12:07:20.967Z","avatar_url":"https://github.com/mzdk100.png","language":"Rust","readme":"# RigelA (the name is taken from the Rigel-A of Orion)\n\nEnglish (en) | [简体中文 (zh-CN)](README.md)\n\n\u003c!-- TOC --\u003e\n* [RigelA (the name is taken from the Rigel-A of Orion)](#rigela-the-name-is-taken-from-the-rigel-a-of-orion)\n  * [Introduction](#introduction)\n  * [Build and run](#build-and-run)\n  * [Donation Support](#donation-support)\n  * [Development documentation](#development-documentation)\n  * [Development Contribution](#development-contribution)\n  * [agreement](#agreement)\n\u003c!-- TOC --\u003e\n\n* [\u003cimg src=\"https://api.gitsponsors.com/api/badge/img?id=743708176\" height=\"20\"\u003e](https://api.gitsponsors.com/api/badge/link?p=NQ2qaC9eM8Eqkk7/NlVCUMnMIYpyYsjpWpVciogJaCWBucmwJ8jIWUJMEdl5e7pq)\n* [Official Site](http://rigela.site)\n* [![Actions Status](https://github.com/mzdk100/rigela/actions/workflows/rust.yml/badge.svg)](https://github.com/mzdk100/rigela/actions)\n* [GitHub](https://github.com/mzdk100/rigela)\n* [GitCode](https://gitcode.com/mzdk100/rigela)\n\n## Introduction\n\nThis project is a Screen Reader project written in rust![logo](images/logo.ico).\nThe first letter r in the name is the same as the first letter of rust, and Orion is the best viewing time in December(This project was initiated in December 2023).\nRust focuses on performance, coding efficiency and security, let us imagine!\nFor the name, please refer\nto [Wikipedia’s introduction to Rigel A](https://zh.wikipedia.org/wiki/%E5%8F%83%E5%AE%BF%E4%B8%83)\nRegarding creating the rust environment: you can refer to relevant documents. If you are not familiar with the rust\nlanguage, it is highly recommended to learn from official documents or authoritative books.\n\n## Build and run\n\n1. Preliminary preparation\n   First you need to download the necessary msvc (if you already have Visual Studio on your computer, skip this step),\n   you can visit [here](https://visualstudio.microsoft.com/zh-hans/downloads/) to get VS Installer;\n   Next we need to have a rust environment. To build the rust environment, you can refer to the introduction\n   in [Rust Programming Language] (https://kaisery.github.io/trpl-zh-cn);\n   Assuming that you already have the above conditions, before building the program we also need to download the rust\n   x86 architecture tool chain and run the following command to install it.\n    ```shell\n    rustup target add i686-pc-windows-msvc\n    rustup update\n    ```\n2. Clone the repository\n    ```shell\n    git clone https://gitcode.com/mzdk100/rigela.git\n    ```\n   or\n    ```shell\n    git clone https://github.com/mzdk100/rigela.git\n    ```\n3. Build the debug version and run it\n    ```shell\n    cd rigela\n    cargo mkenv\n    cargo dev\n    ```\n   Among them, mkenv is used to create a dedicated build program. Because there is a need to build 32-bit and 64-bit\n   programs at the same time, cargo itself cannot do this.\n   Please note: we use `cargo dev` to run instead of `cargo run` otherwise you will encounter errors like (error: only\n   one `--target` argument is supported).\n   If you insist on using the \"cargo run\" command, you can add the \"--target x86_64-pc-windows-msvc\" additional argument\n   to achieve this:\n    ```shell\n    cargo build --target i686-pc-windows-msvc\n    cargo run --target x86_64-pc-windows-msvc\n    ```\n   The first line means building the 32-bit target first, because the second line needs to rely on it. These two lines\n   of commands cannot be written in reverse, so to simplify writing, we created a short command `dev`.\n4. Build the released version\n   The released version of the program has a smaller volume and runs faster than the debug version, but the build speed\n   is slower:\n    ```shell\n    cargo rel\n    ```\n\n## Donation Support\n\nThis project is free for anyone in any country, but if you can financially support our developers, you can enjoy more personalized services from us.\nFor example, if you encounter any difficulties while using this software, you can submit an issue, and we will prioritize solving it for you.\n\nBelow is the current list of core contributors to this project (sorted alphabetically), and you can use the QR code to pay and contact anyone of them:\n- lwboy\u003cliwenboy2008@126.com\u003e:\n  \u003c!--suppress HtmlDeprecatedAttribute --\u003e\n  \u003cp align=\"center\"\u003e\n  \u003c!--suppress CheckImageSize --\u003e\n  \u003cimg alt=\"WeChat payment code\" src=\"images/lw_weixin.png\" width=\"300px\" style=\"margin: 0 30px;\"/\u003e\n  \u003c!--suppress CheckImageSize --\u003e\n  \u003cimg alt=\"Alipay collection code\" src=\"images/lw_alipay.jpg\" width=\"280px\" style=\"margin: 0 30px;\"/\u003e\n  \u003c/p\u003e\n\n- SmileSky\u003cmzdk100@foxmail.com\u003e:\n  \u003c!--suppress HtmlDeprecatedAttribute --\u003e\n  \u003cp align=\"center\"\u003e\n  \u003c!--suppress CheckImageSize --\u003e\n  \u003cimg alt=\"WeChat payment code\" src=\"images/lq_weixin.jpg\" width=\"300px\"  style=\"margin: 0 30px;\"/\u003e\n  \u003c!--suppress CheckImageSize --\u003e\n  \u003cimg alt=\"Alipay collection code\" src=\"images/lq_alipay.jpg\" width=\"280px\"  style=\"margin: 0 30px;\"/\u003e\n  \u003c/p\u003e\n\n\n## Development documentation\n\nWe call on developers who are interested in the open source screen reader project to actively participate. The\ndevelopment documentation is constantly being improved. If you want to contribute to this project, please refer to the\nnext section.\n\n1. Development documents provided by this project:\n    - [Reference document for screen reader main program module](main/README.md)\n    - [Implementation Reference Document for Non Microsoft Official Accessibility Technology](a11y/README)\n    - [Proxy module reference document for 32-bit applications](proxy32/README.md)\n    - [RigelA resource incremental update reference document](resources/README.md)\n2. If you are new to programming, you also need to learn the Rust language and understand the common libraries of Rust:\n    - [Rust programming language Simplified Chinese version](https://kaisery.github.io/trpl-zh-cn)\n    - [Secret Handbook For Rust Beginners](https://rust-book.junmajinlong.com/)\n    - [Rust Language Bible](https://course.rs/about-book.html)\n    - [The Rust Reference](https://doc.rust-lang.org/stable/reference/)\n    - [Rust for Windows repository](https://github.com/microsoft/windows-rs)\n    - [Rust for Windows Documentation](https://microsoft.github.io/windows-docs-rs/)\n    - [Rust's asynchronous runtime tokio repository](https://github.com/tokio-rs/tokio)\n\n## Development Contribution\n\nPowerful functions of program are inseparable from rapid function code iteration. We call on capable friends to\nparticipate in the research and development of this project.\nIf you are a developer, you can fork this repository into your own account, then clone the repository for research and\ndevelopment, and then submit a request for merging.\nIf you still don’t know how to get started, here is the [Contribution Guide](CONTRIBUTING.md) we have prepared for you.\nWe have a long-term planning route, which includes the ideas that all users are most interested in but have not yet been\nimplemented. We look forward to your contributions: [Development Route](https://gitcode.net/mzdk100/rigela/-/issues/1)\nIf you don't know how to program, or the program does not support your local language, you can also contribute to the\ninternationalization of I18N and translate some text into your local language. We welcome your PR.\n\n## agreement\n\nThe open source license of this project is based on the Apache License 2.0, which means that you (whether an individual\nor a company) using, modifying or distributing the code of this project must comply with the following:\nDo not misappropriate the trademark of RigelA project!\nWhen you distribute this work or derivative works, you can no longer need to provide the source code to us! But you must\nbe agreed:\n\n1. Copy a RigelA license to your software directory;\n2. Retain all copyrights, patents and other instructions for this software;\n3. Changed documents must be marked and explained;\n4. The information in the NOTICE file needs to be retained;\n5. You may continue to license subject to the conditions of this License;\n6. You bear full responsibility for the use of this software project, and we do not provide any guarantee.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmzdk100%2Frigela","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmzdk100%2Frigela","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmzdk100%2Frigela/lists"}