From 791c13f29fc84ca461edcb86ad86b5cc2c38a158 Mon Sep 17 00:00:00 2001 From: Misite Bao Date: Mon, 22 Aug 2022 18:02:27 +0800 Subject: [PATCH] chore: sort out files (#1776) * chore: organize resources and delete useless files * chore: add CONTRIBUTING.md * chore: update doc issue template * docs: update and sync README --- .github/ISSUE_TEMPLATE/documentation.yml | 1 + CHANGELOG.md | 3 +- CONTRIBUTING.md | 1 + README.md | 94 ++--- README.zh-Hans.md | 393 +++--------------- .../images/logo-universal.png | Bin .../images/sponsors/bronze-sponsor.png | Bin .../images/sponsors/silver-sponsor.png | Bin package-lock.json | 3 - 9 files changed, 102 insertions(+), 393 deletions(-) create mode 100644 CONTRIBUTING.md rename logo-universal.png => assets/images/logo-universal.png (100%) rename img/bronze sponsor.png => assets/images/sponsors/bronze-sponsor.png (100%) rename img/silver sponsor.png => assets/images/sponsors/silver-sponsor.png (100%) delete mode 100644 package-lock.json diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index b9d47ef2a..61b7c4c38 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -12,6 +12,7 @@ body: - Log undocumented APIs - Update link - Documentation other than non-project code + - Add new language If you followed the documentation but things don't work, take some time to consider if it's the documentation or the code that's wrong. In the latter, prefer using the "[Bug Report](https://github.com/wailsapp/wails/issues/new?assignees=&labels=bug&template=bug_report.yml)" template. diff --git a/CHANGELOG.md b/CHANGELOG.md index 688d6a20f..62b09b25f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1 @@ - -The current changelog may be found at: https://wails.io/changelog/ \ No newline at end of file +The current changelog may be found at: https://wails.io/changelog/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..aa53c412a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +The current Contribution Guidelines can be found at: https://wails.io/community-guide diff --git a/README.md b/README.md index 1d954393a..ca567a84d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@

-
+

+

Build desktop applications using Go & Web Technologies.

- + - + - + CodeFactor @@ -19,66 +20,70 @@ CodeFactor - + - Awesome + Awesome - Release Pipelines + Release Pipelines

- +
+

+ +PLEASE NOTE: As we are approaching the v2 release, we are not accepting any new feature requests or bug reports for v1. If you have a critical issue, please open a ticket and state why it is critical. + +

+
## Internationalization [English](README.md) | [简体中文](README.zh-Hans.md) - - ## Table of Contents
Click me to Open/Close the directory listing -- [1. Internationalization](#nav-1) -- [2. Table of Contents](#nav-2) -- [3. Introduction](#nav-3) - - [3.1 Official Website](#nav-3-1) -- [4. Features](#nav-4) -- [5. Sponsors](#nav-5) -- [6. Installation](#nav-6) -- [7. FAQ](#nav-8) -- [8. Contributors](#nav-9) -- [9. Special Mentions](#nav-10) -- [10. Special Thanks](#nav-11) +- [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)
- - ## Introduction The traditional method of providing web interfaces to Go programs is via a built-in web server. Wails offers a different approach: it provides the ability to wrap both Go code and a web frontend into a single binary. Tools are provided to make this easy for you by handling project creation, compilation and bundling. All you have to do is get creative! - -
-

PLEASE NOTE: As we are approaching the v2 release, we are not accepting any new feature requests or bug reports for v1. If you have a critical issue, please open a ticket and state why it is critical.

-
+### Official Website -### Version 2 +Version 2: Wails v2 has been released in Beta for all 3 platforms. Check out the [new website](https://wails.io) if you are interested in trying it out. -### Legacy v1 Website +Legacy v1 Website: The legacy v1 docs can be found at [https://wails.app](https://wails.app). - +### Roadmap + +The project roadmap may be found [here](https://github.com/wailsapp/wails/discussions/1484). Please consult +this before open up an enhancement request. ## Features @@ -92,16 +97,14 @@ The legacy v1 docs can be found at [https://wails.app](https://wails.app). - Unified eventing system between Go and Javascript - Powerful cli tool to quickly generate and build your projects - Multiplatform -- Uses native rendering engines - *no embedded browser*! - - +- Uses native rendering engines - _no embedded browser_! ## Sponsors This project is supported by these kind people / companies: - + @@ -109,7 +112,7 @@ This project is supported by these kind people / companies:

- + @@ -174,7 +177,6 @@ This project is supported by these kind people / companies: -directory @@ -199,19 +201,11 @@ directory - -## Roadmap - -The project roadmap may be found [here](https://github.com/wailsapp/wails/discussions/1484). Please consult -this before open up an enhancement request. - -## Installation +## Getting Started The installation instructions are on the [official website](https://wails.io/docs/gettingstarted/installation). - - ## FAQ - Is this an alternative to Electron? @@ -235,15 +229,11 @@ The installation instructions are on the [official website](https://wails.io/doc [![Stargazers over time](https://starchart.cc/wailsapp/wails.svg)](https://starchart.cc/wailsapp/wails) - - ## Contributors The contributors list is getting too big for the readme! All the amazing people who have contributed to this project have their own page [here](https://wails.io/credits#contributors). - - ## Special Mentions Without the following people, this project would never have existed: @@ -271,8 +261,6 @@ This project was mainly coded to the following albums: - [Maxthor - Another World](https://open.spotify.com/album/3tklE2Fgw1hCIUstIwPBJF) - [Alun Tan Lan - Y Distawrwydd](https://open.spotify.com/album/0c32OywcLpdJCWWMC6vB8v) - - ## Special Thanks

@@ -287,6 +275,6 @@ This project was mainly coded to the following albums:

-## License Report +## License -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_large) \ No newline at end of file +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_large) diff --git a/README.zh-Hans.md b/README.zh-Hans.md index afa25efff..890fb8d86 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -1,16 +1,17 @@

-
+

+

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

- + - + - + CodeFactor @@ -18,106 +19,89 @@ CodeFactor - - - - - + + - Awesome + Awesome - Release Pipelines + Release Pipelines - -Contributors -

- +
+

+ +请注意：随着我们接近 v2 版本，我们不接受 v1 的任何新功能请求或错误报告。如果您有一个关键问题，请开一个Issue并说明为什么它很关键。 + +

+
## 国际化 [English](README.md) | [简体中文](README.zh-Hans.md) - - ## 内容目录
点我 打开/关闭 目录列表 -- [1. 国际化](#nav-1) -- [2. 内容目录](#nav-2) -- [3. 项目介绍](#nav-3) - - [3.1 官方网站](#nav-3-1) -- [4. 功能](#nav-4) -- [5. 赞助商](#nav-5) -- [6. 安装](#nav-6) - - [6.1 MacOS](#nav-6-1) - - [6.2 Linux](#nav-6-2) - - [6.2.1 Debian/Ubuntu](#nav-6-2-1) - - [6.2.2 Arch Linux / ArchLabs / Ctlos Linux](#nav-6-2-2) - - [6.2.3 Centos](#nav-6-2-3) - - [6.2.4 Fedora](#nav-6-2-4) - - [6.2.5 VoidLinux & VoidLinux-musl](#nav-6-2-5) - - [6.2.6 Gentoo](#nav-6-2-6) - - [6.3 Windows](#nav-6-3) -- [7. 使用方法](#nav-7) - - [7.1 下一步](#nav-7-1) -- [8. 常见问题](#nav-8) -- [9. 贡献者](#nav-9) -- [10. 特别提及](#nav-10) -- [12. 特别感谢](#nav-11) +- [1. 国际化](#国际化) +- [2. 内容目录](#内容目录) +- [3. 项目介绍](#项目介绍) + - [3.1 官方网站](#官方网站) + - [3.2 路线图](#路线图) +- [4. 功能](#功能) +- [5. 赞助商](#赞助商) +- [6. 快速入门](#快速入门) +- [7. 常见问题](#常见问题) +- [8. 贡献者](#贡献者) +- [9. 特别提及](#特别提及) +- [10. 特别感谢](#特别感谢) +- [11. 许可证](#许可证)
- - ## 项目介绍 为 Go 程序提供 Web 界面的传统方法是通过内置 Web 服务器。Wails 提供了一种不同的方法：它提供了将 Go 代码和 Web -前端一起打包成单个二进制文件的能力。通过提供的工具，可以很轻松的完成项目的创建、编译和打包。你所要做的就是发挥想象力！ - - +前端一起打包成单个二进制文件的能力。通过提供的工具，可以很轻松的完成项目的创建、编译和打包。你所要做的就是发挥创造力！ ### 官方网站 -#### v1 - -官方文档可以在 [https://wails.app](https://wails.app) 中找到。 - -#### v2 +V2： Wails v2 已针对所有 3 个平台发布了 Beta 版。如果您有兴趣尝试一下，请查看[新网站](https://wails.io)。 -镜像网站： +旧版 V1： -- [中国大陆镜像站点 - https://wails.top](https://wails.top) +旧版 v1 文档可以在[https://wails.app](https://wails.app)找到。 - +### 路线图 + +项目路线图可在[此处](https://github.com/wailsapp/wails/discussions/1484)找到。在提出增强请求之前请查阅此内容。 ## 功能 - 后端使用标准 Go -- 使用任意前端技术构建 UI 界面 -- 快速为您的 Go 应用生成 Vue、Vuetify、React 前端代码 -- 通过简单的绑定命令将 Go 方法暴露到前端 -- 使用原生渲染引擎 - 无嵌入式浏览器 -- 共享事件系统 -- 原生文件系统对话框 -- 强大的命令行工具 -- 跨多个平台 - - +- 使用您已经熟悉的任何前端技术来构建您的 UI +- 使用内置模板为您的 Go 程序快速创建丰富的前端 +- 从 Javascript 轻松调用 Go 方法 +- 为您的 Go 结构体和方法自动生成 Typescript 声明 +- 原生对话框和菜单 +- 支持现代半透明和“磨砂窗”效果 +- Go 和 Javascript 之间的统一事件系统 +- 强大的 CLI 工具，可快速生成和构建您的项目 +- 跨平台 +- 使用原生渲染引擎 - _没有嵌入式浏览器_！ ## 赞助商 这个项目由以下这些人或者公司支持： - + @@ -125,7 +109,7 @@ Wails v2 已针对所有 3 个平台发布了 Beta 版。如果您有兴趣尝

- + @@ -139,9 +123,6 @@ Wails v2 已针对所有 3 个平台发布了 Beta 版。如果您有兴趣尝 - - - @@ -193,7 +174,6 @@ Wails v2 已针对所有 3 个平台发布了 Beta 版。如果您有兴趣尝 -directory @@ -218,100 +198,10 @@ directory - -## 安装 +## 快速入门 -Wails 使用 cgo 与原生渲染引擎结合，因此需要依赖一些平台的库以及 Go 的安装。基本要求是： - -- Go 1.16 -- npm - - - -### MacOS - -请确保已安装 xcode 命令行工具。这可以通过运行下面的命令来完成： - -`xcode-select --install` - - - -### Linux - - - -#### Debian/Ubuntu - -`sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev` - -_Debian: 8, 9, 10_ - -_Ubuntu: 16.04, 18.04, 19.04_ - -_也成功测试了: Zorin 15, Parrot 4.7, Linuxmint 19, Elementary 5, Kali, Neon_, Pop!\_OS - - - -#### Arch Linux / ArchLabs / Ctlos Linux - -`sudo pacman -S webkit2gtk gtk3` - -_也成功测试了: Manjaro & ArcoLinux_ - - - -#### Centos - -`sudo yum install webkitgtk3-devel gtk3-devel` - -_CentOS 6, 7_ - - - -#### Fedora - -`sudo yum install webkit2gtk3-devel gtk3-devel` - -_Fedora 29, 30_ - - - -#### VoidLinux & VoidLinux-musl - -`xbps-install gtk+3-devel webkit2gtk-devel` - - - -#### Gentoo - -`sudo emerge gtk+:3 webkit-gtk` - - - -### Windows - -Windows 需要 GCC 和相关工具。 建议从 [http://tdm-gcc.tdragon.net/download](http://tdm-gcc.tdragon.net/download) 下载， 安装完成，您就可以开始了。 - - - -## 使用方法 - -**确保 Go modules 是开启的：GO111MODULE=on 并且 go/bin 在您的 PATH 变量中。** - -安装很简单，运行以下命令： - -``` -go get -u github.com/wailsapp/wails/cmd/wails -``` - - - -### 下一步 - -建议在此时阅读 [https://wails.app](https://wails.app) 上面的文档. - - +使用说明在[官网](https://wails.io/docs/gettingstarted/installation)。 ## 常见问题 @@ -328,182 +218,13 @@ go get -u github.com/wailsapp/wails/cmd/wails 当我看到 WebView 时，我想"我真正想要的是围绕构建 WebView 应用程序工作，有点像 Rails 对于 Ruby"。因此，最初它是一个文字游戏（Webview on Rails）。碰巧也是我来自的 [国家](https://en.wikipedia.org/wiki/Wales) 的英文名字的同音。所以就是它了。 - +## 星星增长趋势 + +[![星星增长趋势](https://starchart.cc/wailsapp/wails.svg)](https://starchart.cc/wailsapp/wails) ## 贡献者 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Lea Anthony
💻 🤔 🎨 🖋 💡 🧑‍🏫 📆 🔧 🐛 📝 🚧 📦 👀 💬 🔬 ⚠️ ✅ 📢 👀 📖
stffabi
💻 🤔 🎨 🐛 🚧 📦 👀 💬 🔬 👀 📖 ⚠️
Travis McLane
💻 🔬 📦 🤔 🐛 👀 ⚠️ 💬 📖
Misite Bao
📖 🌍 🔬 🚧
Byron Chris
💻 🔬 🚧 🐛 👀 ⚠️ 💬 🤔 🎨 📦 🚇
konez2k
💻 📦 🤔
Dario Emerson
💻 🐛 🤔 ⚠️
Ian M. Jones
💻 🐛 🤔 ⚠️ 👀 📦

marktohark
💻
Ryan H
💻
Cody Bentley
💻 📦 🤔 💵
Florent
💻 🐛
Alexander Hudek
💻 💵
Tim Kipp
💻
Altynbek Kaliakbarov
💻
Nikolai Zimmermann
💻

k-muchmore
💻
Snider
💻 🤔 📖 💵
Albert Sun
💻 ⚠️
Ariel
💻 🐛
Ilgıt Yıldırım
💻 🐛 💵
Toyam Cox
💻 📦 🐛
hi019
💻 🐛
Arthur Wiebe
💻 🐛

Balakrishna Prasad Ganne
💻
BillBuilt
💻 📦 🤔 💬 💵
Eng Zer Jun
🚧 💻
LGiki
📖
Lontten
📖
Lukas Crepaz
💻 🐛
Marcus Crane
🐛 📖 💵
Qais Patankar
📖

Wakeful-Cloud
💻 🐛
Zámbó, Levente
💻 📦 🐛 ⚠️
Ironpark
💻 🤔
mondy
💻 📖
Benjamin Ryan
🐛
fallendusk
📦 💻
Mat Ryer
💻 🤔 🐛
Abtin
💻 🐛

Adrian Lanzafame
📦 💻
Aleksey Polyakov
🐛 💻
Alexander Matviychuk
💻 📦
AlienRecall
💻 📦
Aman
📖
Amaury Tobias Quiroz
💻 🐛
Andreas Wenk
📖
Antonio Stanković
💻 📦

Arpit Jain
📖
Austin Schey
💻 🐛
Benjamin Thomas
💻 📦 🤔
Bertram Truong
💻 🐛
Blake Bourque
📖
Denis
📖
diogox
💻 📦
Dmitry Gomzyakov
💻 📦

Edward Browncross
💻
Elie Grenon
💻
Florian Didron
💻 🐛 🤔 ⚠️ 👀 📦
GargantuaX
📖 💵
Igor Minin
💻 🐛
Jae-Sung Lee
💻 🤔
Jarek
💻 📦
Junker
📖

Kris Raney
💻 🐛
Luken
📖
Mark Stenglein
💻 🐛
buddyabaddon
💻
MikeSchaap
💻 🐛
NYSSEN Michaël
💻 🐛
Nan0
💻 🤔 ⚠️ 👀
oskar
📖

Pierre Joye
💻 🐛 🤔 ⚠️
Reuben Thomas-Davis
💻 🐛
Robin
💻 🐛
Sebastian Bauer
💻 🤔 ⚠️ 👀 💬
Sidharth Rathi
📖 🐛
Sithembiso Khumalo
💻 🐛
Soheib El-Harrache
💻 🐛 💵
Sophie Au
💻 🐛

Stefanos Papadakis
💻 🐛
Steve Chung
💻 🐛
Timm Ortloff
📖
Tom
💻
Valentin Trinqué
💻 🐛
mattn
💻 🐛
bearsh
💻 🤔 📖
chenxiao
💻 🤔 📖

fengweiqiang
💻 📦
flin7
📖
fred21O4
📖
gardc
📖 ✅
rayshoo
📖
Ishiyama Yuzuki
💻 🐛
佰阅
💻
刀刀
📖 🐛

归位
💻 🐛
skamensky
💻 🤔 📖
dependabot[bot]
💻 🚧
Damian Sieradzki
💵
John Dorman
💵
Ian Sinnott
💵
Arden Shackelford
💵
Bironou
💵

CharlieGo_
💵
overnet
💵
jugglingjsons
💵
Selvin Ortiz
💵
ZanderCodes
💵
Michael Voronov
💵
letheanVPN
💵
Tai Groot
💵

easy-web-it
💵
Michael Olson
💵
EdenNetwork Italia
💵
ondoki
💵
QuEST Rail LLC
💵
Gilgameš
💵
Bernt-Johan Bergshaven
💵
Liam Bigelow
💵

Nick Arellano
💵
Frank Chiarulli Jr.
💵
Tyler
💵
Trea Hauet
💵
Kent 'picat' Gruber
💵
tc-hib
💵
Antonio
📖
MyNameIsAres
📖
- - - - - - - +贡献者列表对于 README 文件来说太大了！所有为这个项目做出贡献的了不起的人在[这里](https://wails.io/credits#contributors)都有自己的页面。 ## 特别提及 @@ -529,8 +250,6 @@ go get -u github.com/wailsapp/wails/cmd/wails - [Maxthor - Another World](https://open.spotify.com/album/3tklE2Fgw1hCIUstIwPBJF) - [Alun Tan Lan - Y Distawrwydd](https://open.spotify.com/album/0c32OywcLpdJCWWMC6vB8v) - - ## 特别感谢

@@ -544,3 +263,7 @@ go get -u github.com/wailsapp/wails/cmd/wails 请点击 logo 让他们知道你的感激之情！

+ +## 许可证 + +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwailsapp%2Fwails.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwailsapp%2Fwails?ref=badge_large) diff --git a/logo-universal.png b/assets/images/logo-universal.png similarity index 100% rename from logo-universal.png rename to assets/images/logo-universal.png diff --git a/img/bronze sponsor.png b/assets/images/sponsors/bronze-sponsor.png similarity index 100% rename from img/bronze sponsor.png rename to assets/images/sponsors/bronze-sponsor.png diff --git a/img/silver sponsor.png b/assets/images/sponsors/silver-sponsor.png similarity index 100% rename from img/silver sponsor.png rename to assets/images/sponsors/silver-sponsor.png diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index 48e341a09..000000000 --- a/package-lock.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "lockfileVersion": 1 -}