2.0 初始化

2023-03-28 10:02:22 +08:00
parent 446c843f8f
commit 323ca1a193
12 changed files with 301 additions and 132 deletions
--- a/README.md
+++ b/README.md
@ -1,14 +1,22 @@
-# ⚡ vite-plugin-earth
+# ⚡ vite-plugin-cesium

-Easily set up a [`cesium`] & [`mars3d-cesium`] project in [`Vite`].
+[![npm](https://img.shields.io/npm/v/vite-plugin-cesium.svg)](https://www.npmjs.com/package/vite-plugin-cesium)
+[![npm](https://img.shields.io/npm/dt/vite-plugin-cesium)](https://www.npmjs.com/package/vite-plugin-cesium)
+
+Easily set up a [`Cesium`] project in [`Vite`].

 [`cesium`]: https://github.com/CesiumGS/cesium
-[`mars3d`]: https://mars3d.cn/
+[`vite`]: https://github.com/vitejs/vite
+
+**update：** if you just wanna a scaffolding by using this plugin, try a simply command `yarn create cesium`, click [create-cesium](https://www.npmjs.com/package/create-cesium) for more info.
+
+Chinese tutorial: [中文教程](https://zhuanlan.zhihu.com/p/354856692)

 ## Install

 ```bash
-npm i vite-plugin-earth -D
+npm i cesium vite-plugin-cesium vite -D
+# yarn add cesium vite-plugin-cesium vite -D
 ```

 ## Usage
@ -17,53 +25,28 @@ add this plugin to `vite.config.js`

 ```js
 import { defineConfig } from 'vite';
-import earth from 'vite-plugin-earth';
+import cesium from 'vite-plugin-cesium';
 export default defineConfig({
-  plugins: [earth()]
+  plugins: [cesium()]
 });
 ```

+add dev command to `package.json`
+
+```json
+"scripts": {
+  "dev": "vite",
+  "build": "vite build"
+}
+```
+
+run:
+
+`yarn dev`
+
 ## Options

-### **pkgName**
-
- **Type :** `string`
- **Default :** `cesium`
-
-`mars3d-cesium` 为`mars3d`对应的依赖库
-
-```js
-import { defineConfig } from 'vite';
-import earth from 'vite-plugin-earth';
-export default defineConfig({
-  plugins: [
-    earth({
-      pkgName: 'mars3d-cesium'
-    })
-  ]
-});
-```
-
-### **libPath**
-
- **Type :** `string`
- **Default :** `lib`
-
-将类库复制到指定的`lib/`目录下面
-
-```js
-import { defineConfig } from 'vite';
-import earth from 'vite-plugin-earth';
-export default defineConfig({
-  plugins: [
-    earth({
-      libPath: 'lib'
-    })
-  ]
-});
-```
-
-### **rebuildCesium**
+**rebuildCesium**

 - **Type :** `boolean`
 - **Default :** `false`
@ -72,12 +55,82 @@ Default copy min cesium file to dist. if `true` will rebuild cesium from source.

 ```js
 import { defineConfig } from 'vite';
-import earth from 'vite-plugin-earth';
+import cesium from 'vite-plugin-cesium';
 export default defineConfig({
  plugins: [
-    earth({
+    cesium({
      rebuildCesium: true
    })
  ]
 });
 ```
+
+## Demo
+
+`src/index.js`
+
+```js
+import { Viewer } from 'cesium';
+import './css/main.css';
+
+const viewer = new Viewer('cesiumContainer');
+```
+
+> or if you like global Cesium object you can write as
+
+```js
+import * as Cesium from 'cesium';
+const viewer = new Cesium.Viewer('cesiumContainer');
+```
+
+`index.html`
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>cesium-vite</title>
+    <script type="module" src="/src/index.js"></script>
+  </head>
+
+  <body>
+    <div id="cesiumContainer"></div>
+  </body>
+</html>
+```
+
+`src/css/main.css`
+
+```css
+html,
+body,
+#cesiumContainer {
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  overflow: hidden;
+}
+```
+
+Add `dev` and `build` commands to `package.json`
+
+```
+"scripts": {
+    "dev": "vite",
+    "build": "vite build"
+},
+```
+
+Run `yarn dev`
+
+For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder.
+
+##
+
+## License
+
+MIT