mirror of
https://github.com/openglobus/openglobus.git
synced 2025-12-08 19:25:27 +00:00
[add] README_CN.md; [update] .gitignore & README.md
This commit is contained in:
onsummer
parent
df90dc9937
commit
36538e224a
11
.gitignore
vendored
11
.gitignore
vendored
@ -1,23 +1,24 @@
|
||||
.metadata
|
||||
|
||||
Thumbs.db
|
||||
|
||||
Thumbs.db
|
||||
|
||||
Release
|
||||
|
||||
|
||||
Debug
|
||||
|
||||
eslint
|
||||
|
||||
|
||||
node_modules
|
||||
.eslintrc
|
||||
.csslintrc
|
||||
*.opensdf
|
||||
|
||||
|
||||
*.sdf
|
||||
*.map
|
||||
api
|
||||
|
||||
package-lock.json
|
||||
yarn.lock
|
||||
|
||||
coverage
|
||||
|
||||
|
||||
66
README.md
66
README.md
@ -1,5 +1,6 @@
|
||||
[](https://travis-ci.com/openglobus/openglobus)
|
||||
[](https://gitter.im/openglobus/og?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
# OpenGlobus
|
||||
|
||||
[OpenGlobus](http://www.openglobus.org/) is a javascript library designed to display interactive 3d maps and planets
|
||||
@ -9,12 +10,73 @@ completely free.
|
||||
The OpenGlobus main goal is to make 3d map features fast, good lookin, user friendly and easy to implement in any
|
||||
related project.
|
||||
|
||||
## Installation
|
||||
## Getting Start
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
npm install @openglobus/og
|
||||
# or
|
||||
yarn add @openglobus/og
|
||||
```
|
||||
|
||||
### Code: using umd lib
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="./libs/og-0.8.10.css">
|
||||
<script src="./libs/og-0.8.10-umd.js"></script>
|
||||
<div id="globus"></div>
|
||||
<script>
|
||||
|
||||
const osm = new og.layer.XYZ("OpenStreetMap", {
|
||||
isBaseLayer: true,
|
||||
url: "//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
|
||||
visibility: true,
|
||||
})
|
||||
|
||||
const globus = new og.Globe({
|
||||
target: "globus", // a HTMLDivElement which its id is `globus`
|
||||
name: "Earth",
|
||||
terrain: new og.terrain.GlobusTerrain(),
|
||||
layers: [osm],
|
||||
autoActivated: true,
|
||||
viewExtent: [5.56707, 45.15679, 5.88834, 45.22260]
|
||||
})
|
||||
|
||||
</script>
|
||||
```
|
||||
|
||||
### Code: using esm lib
|
||||
|
||||
``` html
|
||||
<link rel="stylesheet" href="./libs/og-0.8.10.css">
|
||||
<div id="globus"></div>
|
||||
<script type="module">
|
||||
|
||||
import { layer, Globe, terrain } from './libs/og-0.8.10-esm.js'
|
||||
const { XYZ } = layer
|
||||
const { GlobusTerrain } = terrain
|
||||
|
||||
const osm = new XYZ("OpenStreetMap", {
|
||||
isBaseLayer: true,
|
||||
url: "//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
|
||||
visibility: true,
|
||||
})
|
||||
|
||||
const globus = new Globe({
|
||||
target: "globus", // a HTMLDivElement which its id is `globus`
|
||||
name: "Earth",
|
||||
terrain: new GlobusTerrain(),
|
||||
layers: [osm],
|
||||
autoActivated: true,
|
||||
viewExtent: [5.56707, 45.15679, 5.88834, 45.22260]
|
||||
})
|
||||
|
||||
</script>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
Check out the [hosted examples](http://www.openglobus.org/examples.html), or
|
||||
@ -67,4 +129,4 @@ There are many ways to contribute back to the project:
|
||||
|
||||
MIT
|
||||
=======
|
||||
[](https://travis-ci.com/openglobus/openglobus) [](https://gitter.im/openglobus/og?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://travis-ci.com/openglobus/openglobus) [](https://gitter.im/openglobus/og?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
119
README_CN.md
Normal file
119
README_CN.md
Normal file
@ -0,0 +1,119 @@
|
||||
[](https://travis-ci.com/openglobus/openglobus)[](https://gitter.im/openglobus/og?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
# OpenGlobus
|
||||
|
||||
[OpenGlobus](http://www.openglobus.org/) （TOTRANSLATE）
|
||||
|
||||
## 起步
|
||||
|
||||
### 安装
|
||||
|
||||
```sh
|
||||
npm install @openglobus/og
|
||||
# 或者
|
||||
yarn add @openglobus/og
|
||||
```
|
||||
|
||||
### 代码：使用 umd 引用
|
||||
|
||||
``` html
|
||||
<link rel="stylesheet" href="./libs/og-0.8.10.css">
|
||||
<script src="./libs/og-0.8.10-umd.js"></script>
|
||||
<div id="globus"></div>
|
||||
<script>
|
||||
|
||||
const osm = new og.layer.XYZ("OpenStreetMap", {
|
||||
isBaseLayer: true,
|
||||
url: "//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
|
||||
visibility: true,
|
||||
})
|
||||
|
||||
const globus = new og.Globe({
|
||||
target: "globus", // a HTMLDivElement which its id is `globus`
|
||||
name: "Earth",
|
||||
terrain: new og.terrain.GlobusTerrain(),
|
||||
layers: [osm],
|
||||
autoActivated: true,
|
||||
viewExtent: [108.28125, 20.63278, 118.125, 25.79989] // 广州上空
|
||||
})
|
||||
|
||||
</script>
|
||||
```
|
||||
|
||||
### 代码：使用 esm 引用
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="./libs/og-0.8.10.css">
|
||||
<div id="globus"></div>
|
||||
<script type="module">
|
||||
|
||||
import { layer, Globe, terrain } from './libs/og-0.8.10-esm.js'
|
||||
const { XYZ } = layer
|
||||
const { GlobusTerrain } = terrain
|
||||
|
||||
const osm = new XYZ("OpenStreetMap", {
|
||||
isBaseLayer: true,
|
||||
url: "//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
|
||||
visibility: true,
|
||||
})
|
||||
|
||||
const globus = new Globe({
|
||||
target: "globus", // a HTMLDivElement which its id is `globus`
|
||||
name: "Earth",
|
||||
terrain: new GlobusTerrain(),
|
||||
layers: [osm],
|
||||
autoActivated: true,
|
||||
viewExtent: [108.28125, 20.63278, 118.125, 25.79989] // 广州上空
|
||||
})
|
||||
|
||||
</script>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 文档
|
||||
|
||||
（TOTRANSLATE）
|
||||
|
||||
|
||||
|
||||
## 开始贡献你的代码
|
||||
|
||||
### 开发
|
||||
|
||||
1. 仓库 Clone
|
||||
2. 使用 `npm` 安装依赖
|
||||
|
||||
``` sh
|
||||
npm install
|
||||
```
|
||||
|
||||
### 构建完整的库
|
||||
|
||||
运行命令
|
||||
|
||||
``` sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 其他命令
|
||||
|
||||
（TOTRANSLATE）
|
||||
|
||||
|
||||
|
||||
## 支持此项目
|
||||
|
||||
有多种方式来贡献此项目：
|
||||
|
||||
- （TOTRANSLATE）
|
||||
|
||||
|
||||
|
||||
## 开源许可
|
||||
|
||||
MIT
|
||||
=======
|
||||
|
||||
[](https://travis-ci.com/openglobus/openglobus) 
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user