diff --git a/README.rst b/README.rst index 1bda61f6e..3d0d12f7d 100644 --- a/README.rst +++ b/README.rst @@ -1,26 +1,44 @@ -Mu - A Simple Python Code Editor +Custom Mu - Custom version of A Simple Python Code Editor `Mu `_ ================================ -.. image:: https://mu.readthedocs.io/en/latest/_images/logo.png +[How to make dev env.] + +1. install miniconda + +``https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html``
 + +2. Create virtual environment
 + +``conda create -n mu python=3.8`` + +3. Activate the created virtual env.
 + +``conda activate mu``
 + +4. Clone source codes
 + +``git clone https://github.com/roboticsware/mu`` + +5. Enter the directory of source codes
 + +``cd mu``

 + +6. Install dev dependencies
 + +``pip install -e ".[dev]"`` + +7. Run Mu
 + +``python run.py`` + +8. Build Mu + +``make win64 or macos`` + + +You can also reivew more information about extensive developer documentation `here `_. -Mu is a simple code editor for beginner programmers based on extensive feedback -from teachers and learners. Having said that, Mu is for anyone who wants to use -a simple "no frills" editor. -Mu is a modal editor with modes for many different ways to use Python to create -cool and interesting things. -Mu is written in Python and works on Windows, macOS, Linux and Raspberry Pi. -The project's public facing website is -`https://codewith.mu/ `_. We celebrate the work done by -users of mu at `https://madewith.mu/ `_. -We have `extensive developer documentation `_ -including a guide for -`setting up a development environment `_, -`contributor guidelines `_ and -`some suggested first steps `_. -We want our community to be a friendly place. Therefore, we expect contributors -and collaborators to follow our -`Code of Conduct `_.