GScript 项目教程
1. 项目的目录结构及介绍
gscript/
├── cmd/
│ ├── gscript/
│ │ └── main.go
├── compiler/
│ ├── compiler.go
│ ├── parser.go
│ └── token.go
├── docs/
│ ├── tutorials/
│ │ └── tutorial1.md
│ └── README.md
├── engine/
│ ├── engine.go
│ ├── runtime.go
│ └── vm.go
├── logger/
│ ├── logger.go
│ └── logger_test.go
├── spec/
│ ├── spec.go
│ └── spec_test.go
├── stdlib/
│ ├── stdlib.go
│ └── stdlib_test.go
├── tools/
│ ├── tools.go
│ └── tools_test.go
├── .gitignore
├── .goreleaser.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── ascii_logo.txt
├── go.mod
├── go.sum
├── gscript.go
└── tools.go
cmd/
: 包含项目的命令行接口实现。compiler/
: 包含编译器相关的文件,如解析器和词法分析器。docs/
: 包含项目的文档,包括教程和README文件。engine/
: 包含脚本引擎的核心实现。logger/
: 包含日志记录相关的文件。spec/
: 包含项目的规范和测试文件。stdlib/
: 包含标准库的实现和测试。tools/
: 包含一些辅助工具和测试。- 根目录下的文件包括配置文件、许可证、贡献指南等。
2. 项目的启动文件介绍
项目的启动文件位于 cmd/gscript/main.go
。这个文件是整个项目的入口点,负责初始化并启动脚本引擎。
package main
import (
"github.com/crossoverJie/gscript/engine"
"github.com/crossoverJie/gscript/logger"
)
func main() {
logger.Init()
engine.Start()
}
3. 项目的配置文件介绍
项目的配置文件主要包括以下几个部分:
.gitignore
: 指定Git版本控制系统忽略的文件和目录。.goreleaser.yml
: 用于GoReleaser工具的配置文件,用于自动化发布。go.mod
和go.sum
: Go模块依赖管理文件。LICENSE
: 项目的许可证文件。README.md
: 项目的主文档,包含项目介绍、安装指南和使用说明。
这些配置文件确保了项目的正确运行和维护。
以上是GScript项目的教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用GScript项目。