Bauble 项目教程

Bauble 项目教程

bauble.studioa playground for making 3D art with lisp and math项目地址:https://gitcode.com/gh_mirrors/ba/bauble.studio

1. 项目的目录结构及介绍

Bauble 项目的目录结构如下：

bauble/
├── build/
├── cli/
├── src/
├── studio/
├── test/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── package.json
├── project.janet
├── shell.nix
└── yarn.lock

目录介绍

• build/: 存放构建生成的文件。
• cli/: 存放命令行工具相关的文件。
• src/: 存放项目的主要源代码。
• studio/: 存放与项目开发环境相关的文件。
• test/: 存放测试文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• package.json: 项目的依赖配置文件。
• project.janet: 项目的 Janet 配置文件。
• shell.nix: Nix 包管理器的配置文件。
• yarn.lock: Yarn 包管理器的锁定文件。

2. 项目的启动文件介绍

Bauble 项目的启动文件主要位于 src/ 目录下。以下是一些关键的启动文件：

• src/main.janet: 这是项目的入口文件，负责初始化项目并启动应用。
• src/app.janet: 包含应用的主要逻辑和功能实现。
• src/renderer.janet: 负责渲染相关的逻辑，通常与 WebGL 相关。

3. 项目的配置文件介绍

Bauble 项目的配置文件主要包括以下几个：

• package.json: 定义了项目的依赖包、脚本命令等信息。
• project.janet: 项目的 Janet 配置文件，可能包含项目的构建和运行配置。
• shell.nix: Nix 包管理器的配置文件，定义了项目的开发环境。
• yarn.lock: 锁定项目的依赖版本，确保在不同环境下的一致性。

配置文件示例

package.json

{
  "name": "bauble",
  "version": "1.0.0",
  "scripts": {
    "start": "node src/main.janet",
    "build": "redo"
  },
  "dependencies": {
    "janet": "^1.29.1",
    "emscripten": "^1.39.18",
    "yarn": "^1.22.10"
  }
}

project.janet

(def project
  {
    :name "bauble"
    :version "1.0.0"
    :dependencies ["janet" "emscripten" "yarn"]
  })

shell.nix

{ pkgs ? import <nixpkgs> {} }:

pkgs.mkShell {
  buildInputs = [
    pkgs.janet
    pkgs.emscripten
    pkgs.yarn
  ];
}

通过以上配置文件，可以确保 Bauble 项目在不同环境下的正确构建和运行。

bauble.studioa playground for making 3D art with lisp and math项目地址:https://gitcode.com/gh_mirrors/ba/bauble.studio