Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ttpss930141011 committed Nov 20, 2023
1 parent 1c3f7e8 commit f6e490a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 49 deletions.
49 changes: 6 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,6 @@ The wafer component library based on Vue 3 provides a versatile and customizable
npm run storybook
```

## ⚙️ Features

- Scalable Canvas: The component utilizes HTML5 canvas elements for rendering, allowing for efficient and scalable display of wafer maps.
- Customization Options: Users can customize various aspects of the wafer map, including dimensions, grid visibility, notch position, and more.
- Interactive Focus: The component includes an interactive focus feature, where users can hover over individual dies to view detailed information.

## 🚀 Getting Started

### Installation
Expand Down Expand Up @@ -86,7 +80,7 @@ To use this wafermap component, follow these steps:

<details closed><summary>VWafermap</summary>

Here's a simple example of Coords data:
Here's a example of Coords data:

```javascript
//src\packages\VWafermap\src\types.ts
Expand All @@ -100,44 +94,13 @@ export interface Coords {
}

const coords = [
{
info: ['1'],
x: -2,
y: -2,
dut: 1,
color: '#ff8080'
},
{
info: ['2'],
x: 0,
y: 1,
dut: 2,
color: 'green'
},
{
info: ['4'],
x: 1,
y: 0,
dut: 1,
color: 'rgb(0, 102, 204)'
},
{
info: ['7', '789'],
x: 2,
y: 0,
dut: 1,
color: 'red'
},
{
info: ['9'],
x: 2,
y: 2,
dut: 3,
color: '#b800e6'
}
{ x: -2, y: -2, info: ['1'], dut: 1, color: '#ff8080' },
{ x: 0, y: 1, info: ['2'], dut: 2, color: 'green' },
{ x: 1, y: 0, info: ['4'], dut: 1, color: 'rgb(0, 102, 204)' }
{ x: 2, y: 0, info: ['7', '789'], dut: 1, color: 'red' },
{ x: 2, y: 2, info: ['9'], dut: 3, color: '#b800e6' }
]


```

Here's the simplest example of using the VWafermap component:
Expand Down
File renamed without changes.
6 changes: 0 additions & 6 deletions src/stories/Introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,6 @@ export const RightArrow = () => (
The wafer component library based on Vue 3 provides a versatile and customizable solution for visualizing wafermaps, commonly used in semiconductor manufacturing.
</div></div>

## ⚙️ Features

- Scalable Canvas: The component utilizes HTML5 canvas elements for rendering, allowing for efficient and scalable display of wafer maps.
- Customization Options: Users can customize various aspects of the wafer map, including dimensions, grid visibility, notch position, and more.
- Interactive Focus: The component includes an interactive focus feature, where users can hover over individual dies to view detailed information.

## 🚀 Getting Started

### Installation
Expand Down

1 comment on commit f6e490a

@ttpss930141011
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for vue-wafer-painter ready!

✅ Preview
https://vue-wafer-painter-b0jxuc697-ttpss930141011.vercel.app

Built with commit f6e490a.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.