diff --git a/README.md b/README.md index 81c538e..2bb7cfb 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,12 @@ A Visual Programming Environment and source code generator for specific domains, Getting a copy of the project up and running on your local machine. Supported Platform: GNU/Linux. +``` +git clone https://git.alice.ufsj.edu.br/fls/mosaicode.git +``` -### Prerequisites +### Prerequisites / Dependencies -Open the terminal (Ctrl+Alt+T) and run the following command to install the software dependencies: ``` sudo apt install \ @@ -38,15 +40,8 @@ sudo apt install \ Steps to install the Mosaicode in a virtual environment or in the operational system directory. - #### Virtual Environment / Isolated from system directories -Installing python virtual environment via terminal: - -``` -sudo apt install python3.8-venv -``` - Setting the virtual environment: 1. Create the environment: `python3 -m venv mosaicode` @@ -56,6 +51,13 @@ Setting the virtual environment: More details in the Python 3 *Virtual Environments and Packages* documentation: https://docs.python.org/3/tutorial/venv.html +### Running mosaicode + +1. Active the environment: `source mosaicode/bin/activate` +1. Run the tool: `mosaicode` +1. Deactivate the environment: `deactivate` + + ### Useful Makefile Commands - `make help` - Show all available commands