From 14adbc12aa03a333f8d90d9e9cefc418dd360e17 Mon Sep 17 00:00:00 2001 From: Misite Bao Date: Thu, 15 Sep 2022 19:49:35 +0800 Subject: [PATCH] chore: update README and workflows (#1848) * Update README * Update crowdin.yml * chore: update workflows and README * fix: fix error * feat: remove unnecessary content * Update .github/workflows/build.yml Co-authored-by: Lea Anthony --- .github/workflows/build.yml | 36 +++++++ .../deploy-website-to-wails.top-mirror.yml | 50 --------- .github/workflows/latest-pre.yml | 34 ------ .github/workflows/pr.yml | 32 ------ .github/workflows/release.yml | 34 ------ README.ja.md | 100 ++++++++++-------- README.md | 59 +++++++---- README.zh-Hans.md | 61 ++++++----- crowdin.yml | 16 --- 9 files changed, 165 insertions(+), 257 deletions(-) create mode 100644 .github/workflows/build.yml delete mode 100644 .github/workflows/deploy-website-to-wails.top-mirror.yml delete mode 100644 .github/workflows/latest-pre.yml delete mode 100644 .github/workflows/pr.yml delete mode 100644 .github/workflows/release.yml delete mode 100644 crowdin.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..4791b66df --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,36 @@ +name: Build + +on: + push: + branches: [main] + pull_request: + branches: [main] + workflow_dispatch: + +jobs: + build-v2: + name: v2 Build + if: github.repository == 'wailsapp/wails' + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, windows-latest, macOS-latest] + + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + ref: "master" + submodules: true + fetch-depth: 0 + + - name: Setup Go + uses: actions/setup-go@v3 + with: + go-version: ">=1.18.0" + + - name: Build Wails CLI + run: | + cd ./v2/cmd/wails + go install + wails -help diff --git a/.github/workflows/deploy-website-to-wails.top-mirror.yml b/.github/workflows/deploy-website-to-wails.top-mirror.yml deleted file mode 100644 index bb16babf7..000000000 --- a/.github/workflows/deploy-website-to-wails.top-mirror.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Sync upstream branch and deploy mirror | 同步上游分支并部署镜像 - -on: - schedule: - - cron: "0 8,20 * * *" - workflow_dispatch: - -jobs: - build-and-deploy: - name: Automatic deployment | 自动部署 - runs-on: ubuntu-latest - if: github.repository == 'misitebao/wails' - - steps: - - name: Checkout | 切换到部署分支 - uses: actions/checkout@v2 - with: - ref: "master" - submodules: true - fetch-depth: 0 - - - name: Setup Git | 设置Git - run: | - git config --local user.email "i@misitebao.com" - git config --local user.name "misitebao" - - - name: Add remote upstream repository and sync | 添加远程上游仓库并同步 - run: | - git remote add upstream https://github.com/wailsapp/wails - git pull -v --progress --no-rebase "upstream" master - - - name: Push | 推送 - uses: ad-m/github-push-action@master - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - branch: ${{ github.ref }} - - - name: Build Site | 构建网站 - run: | - cd website && - npm install && npm run build - - - name: Deploy to Server | 部署到服务器 - uses: hengkx/ssh-deploy@v1.0.1 - with: - HOST: ${{ secrets.DEPLOY_HOST }} - USERNAME: ${{ secrets.DEPLOY_HOST_USER }} - PASSWORD: ${{ secrets.DEPLOY_HOST_PASSWORD }} - SOURCE: "website/build" - TARGET: "/www/wwwroot/wails.top" diff --git a/.github/workflows/latest-pre.yml b/.github/workflows/latest-pre.yml deleted file mode 100644 index 870fe55d5..000000000 --- a/.github/workflows/latest-pre.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: latest pre-release -on: - push: - branches: - - develop - tags: - - '**-pre**' -jobs: - - build: - name: Test Build Latest Pre-Release - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest, windows-latest, macOS-latest] - steps: - - - name: Set up Go 1.16 - uses: actions/setup-go@v1 - with: - go-version: 1.16 - id: go - - - name: Check out code into the Go module directory - uses: actions/checkout@v1 - - - name: Get dependencies - run: | - go get -v -d ./... - - name: Build - run: go build -v ./cmd/wails - - - name: Test - run: ./wails version diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml deleted file mode 100644 index df5e53697..000000000 --- a/.github/workflows/pr.yml +++ /dev/null @@ -1,32 +0,0 @@ -name: pr -on: - pull_request: - branches: - - develop -jobs: - - build: - name: Test Build PR - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest, windows-latest, macOS-latest] - steps: - - - name: Set up Go 1.16 - uses: actions/setup-go@v1 - with: - go-version: 1.16 - id: go - - - name: Check out code into the Go module directory - uses: actions/checkout@v1 - - - name: Get dependencies - run: | - go get -v -d ./... - - name: Build - run: go build -v ./cmd/wails - - - name: Test - run: ./wails version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 03fe71f98..000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: release -on: - push: - branches: - - master - tags: - - '!**pre**' -jobs: - - build: - name: Test Build Latest Release - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [ubuntu-latest, windows-latest, macOS-latest] - steps: - - - name: Set up Go 1.16 - uses: actions/setup-go@v1 - with: - go-version: 1.16 - id: go - - - name: Check out code into the Go module directory - uses: actions/checkout@v1 - - - name: Get dependencies - run: | - go get -v -d ./... - - name: Build - run: go build -v ./cmd/wails - - - name: Test - run: ./wails version diff --git a/README.ja.md b/README.ja.md index f15a30efb..ed8757f4b 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,17 +1,21 @@ +

Wails

+


- GoとWebの技術を用いてデスクトップアプリケーションを構築します。

+ GoとWebの技術を用いてデスクトップアプリケーションを構築します。 +
+
- + GitHub - - + + Go Reference CodeFactor @@ -25,11 +29,25 @@ Awesome - - Release Pipelines +
+ + Build + + + GitHub tag (latest SemVer pre-release)

+
+ + + +[English](README.md) · [简体中文](README.zh-Hans.md) · [日本語](README.ja.md) + + + +
+

@@ -38,46 +56,41 @@

-## 国際化 - -[English](README.md) | [简体中文](README.zh-Hans.md) | [日本語](README.ja.md) - ## 目次
クリックすることで、ディレクトリ一覧の開閉が可能です。 -- [1. 国際化](#国際化) -- [2. 目次](#目次) -- [3. はじめに](#はじめに) - - [3.1 公式サイト](#公式サイト) - - [3.2 ロードマップ](#ロードマップ) -- [4. 特徴](#特徴) -- [5. スポンサー](#スポンサー) -- [6. 始め方](#始め方) -- [7. FAQ](#faq) -- [8. コントリビューター](#コントリビューター) -- [9. 特記事項](#特記事項) -- [10. スペシャルサンクス](#スペシャルサンクス) -- [11. ライセンス](#ライセンス) +- [目次](#目次) +- [はじめに](#はじめに) + - [公式サイト](#公式サイト) + - [ロードマップ](#ロードマップ) +- [特徴](#特徴) +- [スポンサー](#スポンサー) +- [始め方](#始め方) +- [FAQ](#faq) +- [コントリビューター](#コントリビューター) +- [特記事項](#特記事項) +- [スペシャルサンクス](#スペシャルサンクス) +- [ライセンス](#ライセンス)
## はじめに -Goプログラムにウェブインタフェースを提供する従来の方法は内蔵のウェブサーバを経由するものですが、 Wailsでは異なるアプローチを提供します。 -Wailsでは Go のコードとウェブフロントエンドを単一のバイナリにまとめる機能を提供します。 +Go プログラムにウェブインタフェースを提供する従来の方法は内蔵のウェブサーバを経由するものですが、 Wails では異なるアプローチを提供します。 +Wails では Go のコードとウェブフロントエンドを単一のバイナリにまとめる機能を提供します。 また、プロジェクトの作成、コンパイル、ビルドを行うためのツールが提供されています。あなたがすべきことは創造性を発揮することです！ ### 公式サイト Version 2: -Wails v2が3つのプラットフォームでベータ版としてリリースされました。興味のある方は[新しいウェブサイト](https://wails.io)をご覧ください。 +Wails v2 が 3 つのプラットフォームでベータ版としてリリースされました。興味のある方は[新しいウェブサイト](https://wails.io)をご覧ください。 レガシー版 v1: -レガシー版 v1のドキュメントは[https://wails.app](https://wails.app)で見ることができます。 +レガシー版 v1 のドキュメントは[https://wails.app](https://wails.app)で見ることができます。 ### ロードマップ @@ -86,19 +99,18 @@ Wails v2が3つのプラットフォームでベータ版としてリリース ## 特徴 -- バックエンドにはGoを利用しています -- 使い慣れたフロントエンド技術を利用してUIを構築できます -- あらかじめ用意されたテンプレートを利用することで、リッチなフロントエンドを備えたGoプログラムを作成できます -- JavaScriptからGoのメソッドを簡単に呼び出すことができます -- あなたの書いたGoの構造体やメソットに応じたTypeScriptの定義が自動生成されます +- バックエンドには Go を利用しています +- 使い慣れたフロントエンド技術を利用して UI を構築できます +- あらかじめ用意されたテンプレートを利用することで、リッチなフロントエンドを備えた Go プログラムを作成できます +- JavaScript から Go のメソッドを簡単に呼び出すことができます +- あなたの書いた Go の構造体やメソットに応じた TypeScript の定義が自動生成されます - ネイティブのダイアログとメニューが利用できます - モダンな半透明や「frosted window」エフェクトをサポートしています -- GoとJavaScript間で統一されたイベント・システムを備えています -- プロジェクトを素早く生成して構築する強力なcliツールを用意しています +- Go と JavaScript 間で統一されたイベント・システムを備えています +- プロジェクトを素早く生成して構築する強力な cli ツールを用意しています - マルチプラットフォームに対応しています - ネイティブなレンダリングエンジンを使用しています - _つまりブラウザを埋め込んでいるわけではありません！_ - ## スポンサー このプロジェクトは、以下の方々・企業によって支えられています。 @@ -211,19 +223,19 @@ Wails v2が3つのプラットフォームでベータ版としてリリース ## FAQ -- Electronの代替品になりますか？ +- Electron の代替品になりますか？ - それはあなたの求める要件によります。WailsはGoプログラマーが簡単に軽量のデスクトップアプリケーションを作成したり、既存のアプリケーションにフロントエンドを追加できるように設計されています。 - Wails v2ではメニューやダイアログといったネイティブな要素を提供するようになったため、軽量なElectronの代替となりつつあります。 + それはあなたの求める要件によります。Wails は Go プログラマーが簡単に軽量のデスクトップアプリケーションを作成したり、既存のアプリケーションにフロントエンドを追加できるように設計されています。 + Wails v2 ではメニューやダイアログといったネイティブな要素を提供するようになったため、軽量な Electron の代替となりつつあります。 - このプロジェクトは誰に向けたものですか？ - HTML/JS/CSSのフロントエンド技術をアプリケーションにバンドルさせることで、サーバーを作成してブラウザ経由で表示させることなくアプリケーションを利用したいGoプログラマにおすすめです。 + HTML/JS/CSS のフロントエンド技術をアプリケーションにバンドルさせることで、サーバーを作成してブラウザ経由で表示させることなくアプリケーションを利用したい Go プログラマにおすすめです。 - 名前の由来を教えて下さい - WebViewを見たとき、私はこう思いました。 - 「私が本当に欲しいのは、WebViewアプリを構築するためのツールであり、Rubyに対するRailsのようなものである」と。 + WebView を見たとき、私はこう思いました。 + 「私が本当に欲しいのは、WebView アプリを構築するためのツールであり、Ruby に対する Rails のようなものである」と。 そのため、最初は言葉遊びのつもりでした（Webview on Rails）。 また、私の[出身国](https://en.wikipedia.org/wiki/Wales)の英語名と同音異義語でもあります。そしてこの名前が定着しました。 @@ -233,7 +245,7 @@ Wails v2が3つのプラットフォームでベータ版としてリリース ## コントリビューター -貢献してくれた方のリストが大きくなりすぎて、readmeに入りきらなくなりました！ +貢献してくれた方のリストが大きくなりすぎて、readme に入りきらなくなりました！ このプロジェクトに貢献してくれた素晴らしい方々のページは[こちら](https://wails.io/credits#contributors)です。 ## 特記事項 @@ -241,8 +253,8 @@ Wails v2が3つのプラットフォームでベータ版としてリリース このプロジェクトは以下の方々の協力がなければ、実現しなかったと思います。 - [Dustin Krysak](https://wiki.ubuntu.com/bashfulrobot) - 彼のサポートとフィードバックはとても大きいものでした。 -- [Serge Zaitsev](https://github.com/zserge) - Wailsのウィンドウで使用している[Webview](https://github.com/zserge/webview)の作者です。 -- [Byron](https://github.com/bh90210) - 時にはByronが一人でこのプロジェクトを存続させてくれたこともありました。彼の素晴らしいインプットがなければv1に到達することはなかったでしょう。 +- [Serge Zaitsev](https://github.com/zserge) - Wails のウィンドウで使用している[Webview](https://github.com/zserge/webview)の作者です。 +- [Byron](https://github.com/bh90210) - 時には Byron が一人でこのプロジェクトを存続させてくれたこともありました。彼の素晴らしいインプットがなければ v1 に到達することはなかったでしょう。 プロジェクトを進める際に、以下のアルバムたちも支えてくれています。 diff --git a/README.md b/README.md index 7ef553f86..7367bca6a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ +

Wails

+


- Build desktop applications using Go & Web Technologies.

+ Build desktop applications using Go & Web Technologies. +
+
- + GitHub - - + + Go Reference CodeFactor @@ -25,11 +29,25 @@ Awesome - - Release Pipelines +
+ + Build + + + GitHub tag (latest SemVer pre-release)

+
+ + + +[English](README.md) · [简体中文](README.zh-Hans.md) · [日本語](README.ja.md) + + + +
+

@@ -38,28 +56,23 @@ PLEASE NOTE: As we are approaching the v2 release, we are not accepting any new

-## Internationalization - -[English](README.md) | [简体中文](README.zh-Hans.md) | [日本語](README.ja.md) - ## Table of Contents
Click me to Open/Close the directory listing -- [1. Internationalization](#internationalization) -- [2. Table of Contents](#table-of-contents) -- [3. Introduction](#introduction) - - [3.1 Official Website](#official-website) - - [3.2 Roadmap](#roadmap) -- [4. Features](#features) -- [5. Sponsors](#sponsors) -- [6. Getting Started](#getting-started) -- [7. FAQ](#faq) -- [8. Contributors](#contributors) -- [9. Special Mentions](#special-mentions) -- [10. Special Thanks](#special-thanks) -- [11. License](#license) +- [Table of Contents](#table-of-contents) +- [Introduction](#introduction) + - [Official Website](#official-website) + - [Roadmap](#roadmap) +- [Features](#features) +- [Sponsors](#sponsors) +- [Getting Started](#getting-started) +- [FAQ](#faq) +- [Contributors](#contributors) +- [Special Mentions](#special-mentions) +- [Special Thanks](#special-thanks) +- [License](#license)
diff --git a/README.zh-Hans.md b/README.zh-Hans.md index ea4a75eb5..6f1185db2 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -1,17 +1,21 @@ +

Wails

+

-
+

- 使用 Go 和 Web 技术构建桌面应用程序。

+ 使用 Go 和 Web 技术构建桌面应用程序。 +
+
- + GitHub - - + + Go Reference CodeFactor @@ -25,11 +29,25 @@ Awesome - - Release Pipelines +
+ + Build + + + GitHub tag (latest SemVer pre-release)

+
+ + + +[English](README.md) · [简体中文](README.zh-Hans.md) · [日本語](README.ja.md) + + + +
+

@@ -38,28 +56,23 @@

-## 国际化 - -[English](README.md) | [简体中文](README.zh-Hans.md) | [日本語](README.ja.md) - ## 内容目录
点我 打开/关闭 目录列表 -- [1. 国际化](#国际化) -- [2. 内容目录](#内容目录) -- [3. 项目介绍](#项目介绍) - - [3.1 官方网站](#官方网站) - - [3.2 路线图](#路线图) -- [4. 功能](#功能) -- [5. 赞助商](#赞助商) -- [6. 快速入门](#快速入门) -- [7. 常见问题](#常见问题) -- [8. 贡献者](#贡献者) -- [9. 特别提及](#特别提及) -- [10. 特别感谢](#特别感谢) -- [11. 许可证](#许可证) +- [内容目录](#内容目录) +- [项目介绍](#项目介绍) + - [官方网站](#官方网站) + - [路线图](#路线图) +- [功能](#功能) +- [赞助商](#赞助商) +- [快速入门](#快速入门) +- [常见问题](#常见问题) +- [贡献者](#贡献者) +- [特别提及](#特别提及) +- [特别感谢](#特别感谢) +- [许可证](#许可证)
diff --git a/crowdin.yml b/crowdin.yml deleted file mode 100644 index 423718c0d..000000000 --- a/crowdin.yml +++ /dev/null @@ -1,16 +0,0 @@ -project_id: 531392 -api_token_env: CROWDIN_PERSONAL_TOKEN -preserve_hierarchy: true -commit_message: '[ci skip]' -files: - - source: /website/docs/**/* - translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name% - - source: /website/blog/**/* - translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name% - - source: /website/src/pages/**/* - ignore: - - '*.js' - - '*.css' - translation: /website/i18n/%two_letters_code%/docusaurus-plugin-content-pages/**/%original_file_name% - - source: /website/i18n/en/**/*.json - translation: /website/i18n/%two_letters_code%/**/%original_file_name%