From 7d35e5bbed93b5690bb8a990e5bd95ed3dd24276 Mon Sep 17 00:00:00 2001 From: ValKmjolnir Date: Wed, 8 Nov 2023 22:23:09 +0800 Subject: [PATCH] :memo: update readme --- README.md | 23 ++++++++++------------- doc/README_zh.md | 26 ++++++++++++-------------- 2 files changed, 22 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 5918eec6..b5abbb54 100644 --- a/README.md +++ b/README.md @@ -57,34 +57,31 @@ the interpreter a useful tool in your own projects. ## __How to Compile__ -![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) -![macOS](https://img.shields.io/badge/Apple%20Inc.-MacOS-green?style=flat-square&logo=apple) -![linux](https://img.shields.io/badge/GNU-Linux-green?style=flat-square&logo=GNU) ![g++](https://img.shields.io/badge/GNU-g++-A42E2B?style=flat-square&logo=GNU) ![clang++](https://img.shields.io/badge/LLVM-clang++-262D3A?style=flat-square&logo=LLVM) ![vs](https://img.shields.io/badge/Visual_Studio-MSVC-5C2D91?style=flat-square&logo=visualstudio) Better download the latest update source of the interpreter and build it! It's quite easy to build this interpreter, what you need are only two things: C++ compiler and the `make`. There is no third-party library used in this project. -__CAUTION__: If want to use the release zip/tar.gz file to build the interpreter, please read the [__Release Notes__](./doc/dev.md#release-notes) to make sure this release file has no fatal bugs. +### __Windows (MinGW-w64)__ -### __`Windows (MinGW-w64)`__ +![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) -Make sure your MinGW thread model is `posix thread model`, otherwise it may not have the thread library. +Make sure MinGW thread model is `posix thread model`, otherwise it may not have the thread library. -> mkdir build -> > mingw32-make nasal.exe -j4 -### __`Windows (Visual Studio)`__ +### __Windows (Visual Studio)__ + +![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) This project gives a [__CMakelists.txt__](./CMakeLists.txt) for you to create project in `Visual Studio`. -### __`Linux/macOS/Unix`__ +### __Linux / macOS / Unix__ + +![linux](https://img.shields.io/badge/GNU-Linux-green?style=flat-square&logo=GNU) ![macOS](https://img.shields.io/badge/Apple%20Inc.-MacOS-green?style=flat-square&logo=apple) -> mkdir build -> -> make -j4 +> make -j You could choose which compiler you want to use: diff --git a/doc/README_zh.md b/doc/README_zh.md index 9ad0b061..52c4f2e4 100644 --- a/doc/README_zh.md +++ b/doc/README_zh.md @@ -47,35 +47,33 @@ __如果有好的意见或建议，欢迎联系我们!__ ## __编译__ -![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) -![macOS](https://img.shields.io/badge/Apple%20Inc.-MacOS-green?style=flat-square&logo=apple) -![linux](https://img.shields.io/badge/GNU-Linux-green?style=flat-square&logo=GNU) ![g++](https://img.shields.io/badge/GNU-g++-A42E2B?style=flat-square&logo=GNU) ![clang++](https://img.shields.io/badge/LLVM-clang++-262D3A?style=flat-square&logo=LLVM) ![vs](https://img.shields.io/badge/Visual_Studio-MSVC-5C2D91?style=flat-square&logo=visualstudio) -我们推荐你下载最新代码包编译，这个项目非常小巧,没有使用任何第三方库，因此编译起来非常轻松， -你只需要这两样东西: C++ 编译器以及make程序。 +推荐下载最新代码包编译，这个项目非常小巧, 没有使用任何第三方库，因此编译起来非常轻松， +只需要这两样东西: C++ 编译器以及make程序。 -__注意__: 如果你想直接下载发行版提供的zip/tar.gz压缩包来构建这个解释器，在下载之前请阅读[__发行日志__](../doc/dev_zh.md#发行日志)以保证这个发行版的文件中不包含非常严重的bug。 +### __Windows 平台 (MinGW-w64)__ -### __`Windows` 平台(`MinGW-w64`)__ +![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) 一定要确保您的 MinGW thread model 是 `posix thread model`, 否则可能存在没有 thread 库的问题。 -> mkdir build -> > mingw32-make nasal.exe -j4 -### __`Windows` 平台(`Vistual Studio`)__ +### __Windows 平台 (Vistual Studio)__ + +![windows](https://img.shields.io/badge/Microsoft-Windows-green?style=flat-square&logo=windows) 项目提供了 [__CMakeLists.txt__](../CMakeLists.txt) 用于在`Visual Studio`中用这种方式来创建项目。 -### __`Linux/macOS/Unix` 平台__ +### __Linux / macOS / Unix 平台__ + +![linux](https://img.shields.io/badge/GNU-Linux-green?style=flat-square&logo=GNU) +![macOS](https://img.shields.io/badge/Apple%20Inc.-MacOS-green?style=flat-square&logo=apple) -> mkdir build -> -> make -j4 +> make -j 你也可以通过如下的其中一行命令来指定你想要使用的编译器：