trafficlunar/blockmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README.md

Browse source
This commit is contained in:
trafficlunar 2025-01-04 23:16:26 +00:00
parent 37be502e1a
commit 591536b29c
1 changed files with 25 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,7 +1,27 @@
<p align="center">
<img src="src/assets/blockmatic-colored.svg" width="400" title="blockmatic">
<h3 align="center">An online image to Minecraft schematic converter with an editor</h3>
todo: add links, development instructions
<a href="https://blockmatic.trafficlunar.net"><img src="src/assets/blockmatic-colored.svg" width="400" title="blockmatic"></a>
<br>
<h3 align="center">Online pixel art editor for Minecraft (with support for images!)</h3>
<h3 align="center"><a href="https://blockmatic.trafficlunar.net"><img src="https://github.com/intergrav/devins-badges/blob/v3/assets/cozy/documentation/website_64h.png" title="Visit the website"></a></h3>
</p>
## Development Instructions
Blockmatic uses React, Vite, pnpm, and TypeScript. To get started in development mode, run:
```bash
$ pnpm run dev
```
This will start the development server and send a link in console to Blockmatic.
To build and preview blockmatic for production, run:
```bash
$ pnpm run build
$ pnpm run preview
```
The first command builds the application, and the second one previews it locally.
To somewhat automatically generate data for blockmatic, please refer to the [README.md](generator/README.md) in the `generator` folder.