search

mitex-rs / mitex

LaTeX support for Typst, powered by Rust and WASM. https://mitex-rs.github.io/mitex/
https://mitex-rs.github.io/mitex/tools/underleaf.html
Apache License 2.0
296 stars 10 forks source link

Add detailed Installation Instructions to README #17

Closed szsdk closed 10 months ago

szsdk commented 10 months ago

I am genuinely impressed with potential of this project and excited about the possibilities it offers. However, I've encountered a bit of a roadblock. As a new user, I'm unsure about the installation process, as the current README file doesn't include an installation section. This has made it challenging for me to get started with the project.

Could you please consider adding an installation guide to the README?

OrangeX4 commented 10 months ago

This is due to the fact that MiTeX is still under development and we are doing final checks and tests for MiTeX's math equation support. Once this is done, we'll publish it as a typst package that you can use as a normal package without installing it.

If you want to use MiTeX before we publish it, you can clone this repo and use the lib.typ file under packages/mitex, just like the example.

Myriad-Dreamin commented 10 months ago

The regular way to install it is just including @preview/mitex:0.0.0 once after it gets published, which is easy.

Also it may not be a good idea to including a "install it locally" section in README.md, because some users were ever confusing by similar section in cetz's README.md, and got stuck on failing to execute installation instructions. Considering that, I feel cloning and using package is for contributors to MiTeX or advanced users. It is still okay to have a CONTRIBUTING.md and contains above content.

szsdk commented 10 months ago

Just test it and it looks amazing. Please feel free to close this issue.