Skip to content

Commit

Permalink
[update] Update Docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
aleversn committed Mar 16, 2024
1 parent 395f671 commit aec53cf
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,31 @@ See the [Release Page](https://github.com/Creator-SN/MathFX/releases).

## 🔨 Tutorial

First, you need to set up the subscriptions, MathFX currently support three formulate OCR APIs. Incluing:
First, you need to set up the subscriptions, MathFX currently supports three formulate OCR APIs. Including:

1. **Mathpix** **(Recommend)**: You can register the OCR API services with `$1` started, and the current pricing is much cheaper than directly using the Mathpix desktop application, each month you can have a `1,000` free requests. (`Although it costs $1 to sign up and a Credit Card is necessary, but the performance of this API is currently the best`). [See Details](https://mathpix.com/ocr)
2. **Xunfei** Formula Recognition API: You can register the OCR API for free and obtain a `500` requests per day. [See Details](https://www.xfyun.cn/service/formula-discern)
3. **Baidu** Formula Recognition API: You can register the OCR API for free and obtain a `1,000` requests per month. [See Details](https://ai.baidu.com/tech/ocr/formula)
1. **SLatex OCR** **(Recommend)**: To build your own backend server, you can deploy the OCR server in this repo [SLatexOCR](https://github.com/aleversn/sLatexOCR).
2. **Mathpix**: You can register the OCR API services with `$1` started, and the current pricing is much cheaper than directly using the Mathpix desktop application, each month you can have a `1,000` free requests. (`Although it costs $1 to sign up and a Credit Card is necessary, but the performance of this API is currently the best`). [See Details](https://mathpix.com/ocr)
3. **Xunfei** Formula Recognition API: You can register the OCR API for free and obtain a `500` requests per day. [See Details](https://www.xfyun.cn/service/formula-discern)
4. **Baidu** Formula Recognition API: You can register the OCR API for free and obtain a `1,000` requests per month. [See Details](https://ai.baidu.com/tech/ocr/formula)

> Note that the performance of `Xunfei` and `Baidu` OCR API is not good in complex science formulates scenes.
Once you have a OCR API subscription, all you need to do is fill the necessary information of the current subscription. Then click this subscrption's item block until the block's border is `blue`.
Once you have an OCR API subscription, all you need to do is fill in the necessary information about the current subscription. Then click this subscription's item block until the block's border is `blue`.

<div align="center">
<img src="./src/assets/docs/subscription.png" style="width: 80%; box-shadow: 0px 3px 8px rgba(0, 0, 0, 0.1);"/>
</div>

Now you can scan for a new formulate scene in the `Scan` page or press `Alt + Shift/Cmd + X` to quick scan.
Now you can scan for a new formulate scene on the `Scan` page or press `Alt + Shift/Cmd + X` to quick scan.

## ⌨ Shortcuts

- `Alt + Shift/Cmd + M`: Show the main program.
- `Alt + Shift/Cmd + X`: Start a new quick scan.
- `Alt` + `Shift/Cmd` + `M`: Show the main program.
- `Alt` + `Shift/Cmd` + `X`: Start a new quick scan.

## 🌏 Language

Currently support two languages.
Currently supports two languages.

- English
- 简体中文(Chinese)
Expand All @@ -68,7 +69,7 @@ This Project is Develop Based on [VFluentForElectron](https://github.com/Creator

MIT License

Copyright (c) 2022 Creator SN®
Copyright (c) 2024 Creator SN®

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
Binary file modified src/assets/docs/scan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/docs/scan_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/docs/subscription.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aec53cf

Please sign in to comment.