v0.2.0

DRincs-Productions · Aug 10, 2024 · dbe3e86 · dbe3e86
1 parent 269ef7a
commit dbe3e86
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,38 @@
-## Add assert
+# Getting Started
+
+You can start using Pixi’VN by initializing a new project.
+
+## Prerequisites
+
+* [Node.js](https://nodejs.org/) version 18 or higher.
+* Text Editor with TypeScript support.
+  * [Visual Studio Code](https://code.visualstudio.com/) is recommended.
+
+## Project Initialization
+
+To initialize a new project, you can use the following command:
 
 ```bash
-git submodule add <link> '<Neme Folder>'
+# npm
+npm create pixi-vn@latest
+
+# yarn
+yarn create pixi-vn@latest
+
+# pnpm
+pnpm create pixi-vn@latest
+
+# bun
+bun create pixi-vn@latest
 ```
+
+The supported template presets are:
+
+* **[Basic Visual Novel - Web page (Vite + React + MUI joy)](https://github.com/DRincs-Productions/pixi-vn-react-template)**
+* **[Basic Visual Novel - Multi Device (Vite + React + MUI joy + Electron Forge)](https://github.com/DRincs-Productions/pixi-vn-react-template/tree/electron)**
+
+( More templates will be added in the future, see this [issue](https://github.com/DRincs-Productions/pixi-vn/issues/162) for more information )
+
+After the project is initialized, you can open the project directory with your text editor (VSCode is recommended) and start developing your visual novel.
+
+Into all templates there is a `README.md` file with more information about the project.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
 {
   "name": "create-pixi-vn",
-  "version": "0.1.9",
+  "description": "Create a new Pixi’VN project",
+  "version": "0.2.0",
   "type": "module",
   "license": "GPL-3.0",
   "author": "DRincs-Productions",

diff --git a/src/index.ts b/src/index.ts
@@ -27,7 +27,7 @@ const cwd = process.cwd()
 const helpMessage = `\
 Usage: create-pixi-vn [OPTION]... [DIRECTORY]
 
-Create a new Pixi'VN project.
+Create a new Pixi’VN project.
 With no arguments, start the CLI in interactive mode.
 
 Options:

diff --git a/template-react-vite-muijoy b/template-react-vite-muijoy
diff --git a/template-react-vite-muijoy-multidevice b/template-react-vite-muijoy-multidevice
+3 −3		README.md
+9,881 −9,821		package-lock.json
+9 −9		package.json
+5 −1		src/main.tsx
+14 −11		README.md
+102 −112		package-lock.json
+10 −11		package.json
+5 −1		src/main.tsx