Skip to content

Commit

Permalink
update readme;
Browse files Browse the repository at this point in the history
  • Loading branch information
chaoqing committed May 24, 2022
1 parent 4fd450d commit 5b6d8a0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Language translator from MATLAB to Python

This package provides a utility `mh_python` to translate MATLAB into Python format while keeping most of the MATLAB accent.
The generated Python code hope to be directly runnable with the [mat2py](https://mat2py.org) framework.
The generated Python code hope to be directly runnable with the [mat2py](https://mat2py.org) engine.

This `mh_python` utility was initially developed under fork of [MISS_HIT](https://github.com/florianschanda/miss_hit) and
then exported to a seperated [branch](https://github.com/mat2py/miss_hit/tree/mh_python) for uploading to [PyPi](https://pypi.org/project/mh-python/).
This `mh_python` utility was initially developed under fork of [MISS_HIT](https://github.com/florianschanda/miss_hit)
and then exported to this seperated repository for uploading to [PyPi](https://pypi.org/project/mh-python/).

We hope to merge this utility back to `miss_hit` after it is stable.
The development may still happen inside the [fork](https://github.com/mat2py/miss_hit). We hope to merge this utility
back to `miss_hit` after it is stable.

## Usage

Try it online [here](https://translate.mat2py.org/).

```python
# must install
python3 -m pip install mh-python
python3 -m pip install -U mh-python

# recommend install for prettify generated code
python3 -m pip install black isort --upgrade
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

setuptools.setup(
name="mh_python",
version="0.0.10",
version="0.0.11",
author="Chaoqing Wang",
author_email="[email protected]",
description="Matlab to Python/Numpy translator",
Expand Down

0 comments on commit 5b6d8a0

Please sign in to comment.