From da43ec5193efb5c112d8962f7553347499ebc5af Mon Sep 17 00:00:00 2001 From: ValKmjolnir Date: Sun, 2 Jul 2023 20:39:28 +0800 Subject: [PATCH] :memo: update docks --- README.md | 13 +++++-------- doc/README_zh.md | 15 ++++++--------- doc/vs.md | 43 ------------------------------------------- 3 files changed, 11 insertions(+), 60 deletions(-) delete mode 100644 doc/vs.md diff --git a/README.md b/README.md index b2dd19b..ea02047 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,6 @@ the interpreter a useful tool in your own projects. ![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) @@ -68,19 +67,17 @@ Better download the latest update source of the interpreter and build it! It's q __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. -Use g++(`MinGW-w64`) or MSVC(`Visual Studio`) on `Windows` . - -Use g++/clang++ on `Linux/macOS/Unix` platform (we suggest `clang`). - -On `Windows (MinGW-w64)`: +### __`Windows (MinGW-w64)`__ Make sure your MinGW thread model is `posix thread model`, otherwise it may not have the thread library. > mingw32-make nasal.exe -You could create project in `Visual Studio` by this way: [__Click__](./doc/vs.md). +### __`Windows (Visual Studio)`__ -On `Linux/macOS/Unix`: +This project gives a [__CMakelists.txt__](./CMakeLists.txt) for you to create project in `Visual Studio`. + +### __`Linux/macOS/Unix`__ > make nasal diff --git a/doc/README_zh.md b/doc/README_zh.md index c8b7515..b7526bb 100644 --- a/doc/README_zh.md +++ b/doc/README_zh.md @@ -49,29 +49,26 @@ __如果有好的意见或建议，欢迎联系我们!__ ![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程序。 __注意__: 如果你想直接下载发行版提供的zip/tar.gz压缩包来构建这个解释器，在下载之前请阅读[__发行日志__](../doc/dev_zh.md#发行日志)以保证这个发行版的文件中不包含非常严重的bug。 -`Windows` 用户通过 g++(`MinGW-w64`) 或者使用 MSVC(`Visual Studio`) 来进行编译。 - -`Linux/macOS/Unix` 用户可以使用 g++ 或者 clang++ 来进行编译 (建议您使用 `clang`)。 - -`Windows` 平台(`MinGW-w64`): +### __`Windows` 平台(`MinGW-w64`)__ 一定要确保您的 MinGW thread model 是 `posix thread model`, 否则可能存在没有 thread 库的问题。 > mingw32-make nasal.exe -你也可以在`Visual Studio`中用这种方式来创建项目：[__点击跳转__](../doc/vs.md)。 +### __`Windows` 平台(`Vistual Studio`)__ -`Linux/macOS/Unix` 平台: +项目提供了 [__CMakeLists.txt__](../CMakeLists.txt) 用于在`Visual Studio`中用这种方式来创建项目。 + +### __`Linux/macOS/Unix` 平台__ > make nasal diff --git a/doc/vs.md b/doc/vs.md deleted file mode 100644 index b828435..0000000 --- a/doc/vs.md +++ /dev/null @@ -1,43 +0,0 @@ -# Create VS project | 创建 VS 工程 - -## First | 首先 - -We give a [__CMakeLists.txt__](../CMakeLists.txt) for you to create new VS project from it. - -我们为你提供了 [__CMakeLists.txt__](../CMakeLists.txt) 用于创建新的 VS 工程。 - -If you are using this way, you will __not need__ to continue reading. - -如果你使用的是这种方式，下面的内容你就 __不需要__ 再读了。 - -Creating VS project from a CMake file is the __simplest__ way. - -从 CMake 文件创建 VS 工程是 __最简单__ 的方式。 - -## How to Create VS project - -Make sure you are using VS 2022. You may not get the dynamic libraries by using this way to compile. - -1. Get code from this repo using `git`. - -2. In Visual Studio, click `File`->`New`->`Project From Existing Code...`. - -3. Select `Visual C++`->`Next`->choose `project file location`->write the `project name` at ease->`Finish`. - -4. Remove cpp files in `module` to avoid compilation problems.(they should be compiled to dynamic libraries) - -5. Click `Source Files` in `Search Solution Explorer` at left, right click `main.cpp`, compile. - -## 如何创建VS工程 - -确保你使用的是 VS 2022。这个方式可能无法生成一些动态库。 - -1. 用 `git` 从这个仓库获取代码。 - -2. 在VS的界面，点击文件(F)->新建(N)->从现有代码创建项目(E)。 - -3. 选择创建 `Visual C++` 项目->下一步->项目文件位置选择你下载的代码存放的文件夹->填项目名称，随便写->完成。 - -4. 从项目中去掉 `module` 里的cpp文件，以防止编译错误。(那些本应该编译到动态库) - -5. 点开左侧解决方案资源管理器中的 `Source Files`，右键点击 `main.cpp`，编译。