Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat READMEなど修正 #34

Merged
merged 2 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
40 changes: 40 additions & 0 deletions DEV.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# dev

## Design

https://www.figma.com/file/FDTRV5hqFygwRyJWC2XBKU/Mahiwa-GUI%E3%82%A2%E3%83%97%E3%83%AA?type=design&node-id=0%3A1&mode=design&t=tbvAPPO5aoq10Gsa-1

## Install

https://tauri.app/v1/guides/getting-started/prerequisites
をもとに必要なソフトウェアの用意

```
make init
```

Rust側は実行時に自動解決

## Run

```
make build
```

## Build

```
make build
```

- src-tauri/target/release/bundle/deb/mahiwa_0.1.0_amd64.deb
- src-tauri/target/release/bundle/appimage/mahiwa_0.1.0_amd64.AppImage

https://tauri.app/v1/guides/building/

AppImageの動作確認手順

```
chmod +x mahiwa_0.1.0_amd64.AppImage
./mahiwa_0.1.0_amd64.AppImage
```
76 changes: 43 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,54 @@
# Mahiwa

[![Release](https://github.com/project-mahiwa/mahiwa/actions/workflows/release.yml/badge.svg)](https://github.com/project-mahiwa/mahiwa/actions/workflows/release.yml)
[![Lint](https://github.com/project-mahiwa/mahiwa/actions/workflows/lint.yml/badge.svg)](https://github.com/project-mahiwa/mahiwa/actions/workflows/lint.yml)
[![静的解析 (svelte-check)](https://github.com/project-mahiwa/mahiwa/actions/workflows/staticAnalysis.yml/badge.svg)](https://github.com/project-mahiwa/mahiwa/actions/workflows/staticAnalysis.yml)

## Design

https://www.figma.com/file/FDTRV5hqFygwRyJWC2XBKU/Mahiwa-GUI%E3%82%A2%E3%83%97%E3%83%AA?type=design&node-id=0%3A1&mode=design&t=tbvAPPO5aoq10Gsa-1
<div align="center">
<a href="https://mahiwa.usuyuki.net" target="_blank">
<picture>
<!-- SvelteKitで使ってるロゴを拝借する -->
<img width="300" src="src/lib/assets/logo/mahiwa-logo-v1.png" alt="Mahiwa logo">
</picture>
</a>
<h1>Mahiwa</h1>
<p>
MAHIWA can be written in Any High-level language and run on MicroController, which Integrates the latest functionality with WebAssembly.
</p>

<p>
<a href="https://github.com/project-mahiwa/mahiwa/actions/workflows/release.yml">
<img src="https://github.com/project-mahiwa/mahiwa/actions/workflows/release.yml/badge.svg" alt="Build Status">
</a>
<a href="https://github.com/project-mahiwa/mahiwa/actions/workflows/lint.yml">
<img src="https://github.com/project-mahiwa/mahiwa/actions/workflows/lint.yml/badge.svg" alt="Build Status">
</a>
<a href="https://github.com/project-mahiwa/mahiwa/actions/workflows/staticAnalysis.yml">
<img src="https://github.com/project-mahiwa/mahiwa/actions/workflows/staticAnalysis.yml/badge.svg" alt="Build Status">
</a>
</p>
</div>

<br />

This is Mahiwa's GUI writing tool.

Support Languages: English, 日本語

# usage

## Dependencies

mahiwa uses `git`, `xxd`, `pio(platformIO)` commands internally.

## Install

https://tauri.app/v1/guides/getting-started/prerequisites
をもとに必要なソフトウェアの用意

```
make init
```

Rust側は実行時に自動解決
Please access https://github.com/project-mahiwa/mahiwa/releases and download the latest image that suits your environment.

## Run
### Linux

```
make build
./mahiwa_{version}_amd64.AppImage
```

## Build
### Mac

```
make build
```

- src-tauri/target/release/bundle/deb/mahiwa_0.1.0_amd64.deb
- src-tauri/target/release/bundle/appimage/mahiwa_0.1.0_amd64.AppImage
On Mac, you can use brew to resolve the necessary dependencies, but we have not confirmed its operation.

https://tauri.app/v1/guides/building/
### Windows

AppImageの動作確認手順

```
chmod +x mahiwa_0.1.0_amd64.AppImage
./mahiwa_0.1.0_amd64.AppImage
```
There is an installer for Windows, but it is not supported.