From ed1ff013645dc0f023aa67228871c8b3cafb2190 Mon Sep 17 00:00:00 2001 From: LT Date: Fri, 7 Jan 2022 21:00:14 +0800 Subject: [PATCH 1/3] Update the readme file. --- README.md | 1 + README_ZH.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 25c4f8b..e5da970 100755 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Install Quingo runtime system with required simulators using the following comma git clone https://gitee.com/quingo/quingo-runtime.git cd /your/download/path/quingo-runtime/ pip install -e . +python -m quingo.install_quingoc ``` Upon success, it will automatically install the Quingo runtime system (this package), the PyQCAS simulator and the PyQCISim simulator. diff --git a/README_ZH.md b/README_ZH.md index 955697d..3506a2c 100755 --- a/README_ZH.md +++ b/README_ZH.md @@ -13,6 +13,7 @@ git clone https://gitee.com/quingo/quingo-runtime.git cd /your/download/path/quingo-runtime/ pip install -e . +python -m quingo.install_quingocquingo ``` ### 安装青果编译器 -- Gitee From 6ac2212da50ca63789eff8ecaced3085e7aa63db Mon Sep 17 00:00:00 2001 From: LT Date: Fri, 7 Jan 2022 21:04:43 +0800 Subject: [PATCH 2/3] Update the readme files. --- README.md | 4 +--- README_ZH.md | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e5da970..c422af8 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 python -m quingo.install_quingoc ``` diff --git a/README_ZH.md b/README_ZH.md index 3506a2c..3492867 100755 --- a/README_ZH.md +++ b/README_ZH.md @@ -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 python -m quingo.install_quingocquingo ``` -- Gitee From 248a939d6a62d9831e45a602c85566ef6b92bc5d Mon Sep 17 00:00:00 2001 From: LT Date: Fri, 7 Jan 2022 22:07:28 +0800 Subject: [PATCH 3/3] Update the readme file. --- README.md | 8 +++++--- README_ZH.md | 12 +++++++----- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c422af8..8d5b002 100755 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ The Quingo installation comprises of two main steps: Install Quingo runtime system with required simulators using the following command: ```sh pip install quingo -python -m quingo.install_quingoc ``` Upon success, it will automatically install the Quingo runtime system (this package), the PyQCAS simulator and the PyQCISim simulator. @@ -24,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 3492867..6649923 100755 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,6 +1,6 @@ # 青果运行时系统 - 青果（Quingo）运行时系统能够与青果编译器协同工作，旨在为用户提供编程和模拟青果程序的能力。 +青果（Quingo）运行时系统能够与青果编译器协同工作，旨在为用户提供编程和模拟青果程序的能力。 ## 环境安装 @@ -11,7 +11,6 @@ 依次执行以下命令便可以安装青果运行时系统、PyQCAS模拟器以及PyQCISim模拟器。 ```sh pip install quingo -python -m quingo.install_quingocquingo ``` ### 安装青果编译器 @@ -21,11 +20,14 @@ python -m quingo.install_quingocquingo 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)来获取青果编译器。 -- Gitee