Skip to content

Commit a740cd7

Browse files
authored
Update README.md
Restore README
1 parent 0a31fb5 commit a740cd7

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
# Vue 3 + TypeScript + Vite
1+
# MaplatEditor
2+
![Maplat Logo](https://code4history.github.io/Maplat/page_imgs/maplat.png)
23

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
4+
[Maplat](https://github.com/code4history/Maplat/wiki) is the cool Historical Map/Illustrated Map Viewer.
5+
MaplatEditor is support project of Maplat, providing the data editor of Maplat.
6+
***NOTE:*** This project is quite new, so now support Japanese GUI only.
47

5-
## Recommended IDE Setup
8+
[Maplat](https://github.com/code4history/Maplat/wiki) は古地図/絵地図を歪める事なくGPSや正確な地図と連携させられるオープンソースプラットフォームです。
9+
MaplatEditorはMaplatのサポートプロジェクトで、データエディタを提供します。
610

7-
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
11+
# パッケージ版 ([最新バージョン0.6.5](https://github.com/code4history/MaplatEditor/releases/tag/v0.6.5))
12+
* Windows用 (64ビット): https://github.com/code4history/MaplatEditor/releases/download/v0.6.5/MaplatEditor.Setup.0.6.5.exe
13+
* Mac用 (X64): https://github.com/code4history/MaplatEditor/releases/download/v0.6.5/MaplatEditor-0.6.5.dmg
14+
* Mac用 (Apple Silicon): Apple Silicon binary of 0.6.5 is not provided, because of electron-builder's bug. Please use intel binary instead.
815

9-
## Type Support For `.vue` Imports in TS
16+
# GUI
17+
## MapList (地図一覧)
1018

11-
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
19+
![MapList](https://raw.githubusercontent.com/code4history/MaplatEditor/master/maplist.png)
1220

13-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
21+
## MapEdit (地図編集)
1422

15-
1. Disable the built-in TypeScript Extension
16-
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17-
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
18-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
23+
![MapEdit](https://raw.githubusercontent.com/code4history/MaplatEditor/master/mapedit.png)

0 commit comments

Comments
 (0)