diff --git a/README.md b/README.md index 25c4f8b4ac1e84a8e3335c212a51c499d8abb3dc..8d5b002a6e03dbb04cc6a50bedcf9532d253beb9 100755 --- a/README.md +++ b/README.md @@ -9,9 +9,7 @@ The Quingo installation comprises of two main steps: ### Install the Runtime system and simulator Install Quingo runtime system with required simulators using the following command: ```sh -git clone https://gitee.com/quingo/quingo-runtime.git -cd /your/download/path/quingo-runtime/ -pip install -e . +pip install quingo ``` Upon success, it will automatically install the Quingo runtime system (this package), the PyQCAS simulator and the PyQCISim simulator. @@ -25,13 +23,16 @@ Two versions of Quingo compiler has been developed: #### Install the Mlir-based Compiler -At present, as long as all the commands in the step of [Install the Runtime system and simulator](#install-the-runtime-system-and-simulator) are executed, the binary file of the mlir-based compiler will be automatically downloaded. +Install the mlir-based Quingo compiler using the following command: +```sh +python -m quingo.install_quingoc +``` #### Install the Xtext-based Compiler At present, the java executable file of xtext-based compiler has not yet been automatically downloaded, so users need to download [java executable](https://github.com/Quingo/compiler_xtext/releases) separately to get the xtext-based compiler. -After downloading the binary, you need to call specify the compiler path for once in python using the following command: +After downloading the binary, you need to call specify the compiler path for once in python using the following commands: ```python import quingo # for xtext compiler diff --git a/README_ZH.md b/README_ZH.md index 955697dc26425216d0fc9043abc5e3c9023d5984..66499236bfc928ea1c8aec88b5c95e526233752a 100755 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,6 +1,6 @@ # 青果运行时系统 - 青果(Quingo)运行时系统能够与青果编译器协同工作,旨在为用户提供编程和模拟青果程序的能力。 +青果(Quingo)运行时系统能够与青果编译器协同工作,旨在为用户提供编程和模拟青果程序的能力。 ## 环境安装 @@ -10,9 +10,7 @@ 依次执行以下命令便可以安装青果运行时系统、PyQCAS模拟器以及PyQCISim模拟器。 ```sh -git clone https://gitee.com/quingo/quingo-runtime.git -cd /your/download/path/quingo-runtime/ -pip install -e . +pip install quingo ``` ### 安装青果编译器 @@ -22,11 +20,14 @@ pip install -e . 1. 基于`mlir`的青果编译器,该编译器可以生成能够被PyQCISim模拟器模拟的QCIS指令。 2. 基于`xtext`的青果编译器,该编译器可以生成能够被PyQCAS模拟器模拟的eQASM指令。 -#### 基于`mlir`的青果编译器 +#### 安装基于`mlir`的青果编译器 -目前,只要执行了[安装运行时系统以及模拟器](#安装运行时系统以及模拟器)步骤中的所有命令,基于`mlir`的青果编译器的二进制文件便会自动下载,因此用户可以直接使用,无需单独下载。 +执行以下命令便可自动下载安装基于`mlir`的青果编译器: +```sh +python -m quingo.install_quingoc +``` -#### 基于`xtext`的青果编译器 +#### 安装基于`xtext`的青果编译器 目前,基于`xtext`的青果编译器还未实现自动下载,故用户需要单独下载[java二进制文件](https://github.com/Quingo/compiler_xtext/releases)来获取青果编译器。