Skip to content
This repository has been archived by the owner on Apr 18, 2022. It is now read-only.

Update Readme: add Quick Start #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ It's very useful for showing a mind map on any web pages. Like a blog post, a bo

XMind Viewer is an official project, made by XMind team, and written in TypeScript.

## Quick Start

```bash
git clone https://github.com/xmindltd/xmind-viewer.git
cd xmind-viewer
# install project dependencies
npm install --registry=https://registry.npm.taobao.org
# install parcel
npm install -g parcel --registry=https://registry.npm.taobao.org
# run
parcel example\index.html
# build
# npm install cssnano --registry=https://registry.npm.taobao.org
# parcel build example\index.html
```

## Usage and Getting Started

Expand Down