Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JeongJun-Lee committed Dec 28, 2024
1 parent af7dee9 commit 180471f
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 17 deletions.
71 changes: 54 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,39 +1,76 @@
Custom Mu - Custom version of A Simple Python Code Editor `Mu <https://madewith.mu/>`_
================================

[How to make dev env.]
=======================================================================================

Additional new features
-----------------------
Pygame Zero
```````````
- Integrated `the enhanced Pygame Zero Helper Lib <https://github.com/roboticsware/pgzhelper>`_ to Mu
.. image:: screenshots/pgzhelper.png
- Integrated `PyInstaller <https://pyinstaller.org>`_ to package and deploy your Pygame Zero Game project to one executable file
.. image:: screenshots/pyinstaller.png

Respberry Pi Pico
`````````````````
- Enhanced the file manager for `Respberry Pi Pico board <https://www.raspberrypi.com/products/raspberry-pi-pico>`_
- Navigation in the both local andd device file manager
- Copy a file between both local andd device file manager
- Delete a file in the local file manager
- Enhanced the Start/Stop button to run your code directly on the RPi Pico
- Integrated `the enhanced Picozero Lib <https://picozero-rw.readthedocs.io>`_ to Mu
- Manual install of PicoZero Lib by Drag-and-drop
.. image:: screenshots/picozero.png


Editor
``````
- Shows a code-assitance of your own language by locale
.. image:: screenshots/code-assistance.jpg
- Added new Shortcuts
================== ======================
Shortcuts Functions
================== ======================
Ctrl(Cmd) + w Close tab
Ctrl(Cmd) + , or . Move letf or right tab
================== ======================
- Enhanced the Find function
- Show the very word in the Find window based on your selected text


How to make dev env. and build
------------------------------

1. install miniconda

``https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html``
``https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html``

2. Create virtual environment
2. Create virtual environment

``conda create -n mu python=3.8``
``conda create -n mu python=3.8``

3. Activate the created virtual env.
3. Activate the created virtual env.

``conda activate mu``
``conda activate mu``

4. Clone source codes
4. Clone source codes

``git clone https://github.com/roboticsware/mu``
``git clone https://github.com/roboticsware/mu``

5. Enter the directory of source codes
5. Enter the directory of source codes

``cd mu``


``cd mu``

6. Install dev dependencies
6. Install dev dependencies

``pip install -e ".[dev]"``
``pip install -e ".[dev]"``

7. Run Mu
7. Run Mu

``python run.py``
``python run.py``

8. Build Mu

``make win64 or macos``
``make win64 or macos``


You can also reivew more information about extensive developer documentation `here <https://mu.readthedocs.io/>`_.
Expand Down
Binary file added screenshots/code-assistance.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/pgzhelper.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 added screenshots/picozero.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 added screenshots/pyinstaller.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 180471f

Please sign in to comment.