Skip to content

Commit

Permalink
📝 Kreedzt - add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kreedzt committed Apr 5, 2023
1 parent 149e352 commit c2c1669
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 4 deletions.
60 changes: 56 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,59 @@
# Tauri + Solid + Typescript
# RWR 服务器状态查询

This template should help get you started developing with Tauri, Solid and Typescript in Vite.
![license](https://badgen.net/github/license/Kreedzt/rwr-server-ping)
![latest release](https://badgen.net/github/release/Kreedzt/rwr-server-ping)
![commits count](https://badgen.net/github/commits/Kreedzt/rwr-server-ping)
![last commit](https://badgen.net/github/last-commit/Kreedzt/rwr-server-ping)

## Recommended IDE Setup
该工具通过调用 rwr 官方服务器查询地址, 可快速查询服务器状态信息

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
English | [简体中文](README.md)

## 快速上手

[Release](https://github.com/Kreedzt/rwr-server-ping/releases) 页面下载最新的构建包, 双击使用即可

当前应用包含如下功能:

- [x] 延迟检测
- [x] 一键加入服务器 / 复制启动命令
- [x] 收藏夹

## 开发

该项目是基于 [tauri](https://tauri.app/) 进行创建的项目, 同时依赖以下 2 个语言环境:

- [Nodejs](https://nodejs.org/en/)
- [Rust](https://www.rust-lang.org/)

在安装好环境后, 本项目依赖 `pnpm` 进行前端包管理

1. 安装 `pnpm`

```bash
npm i -g pnpm
```

2. 使用 `pnpm` 安装前端依赖包

```bash
pnpm i
```

3. 启动开发环境

```
pnpm tauri dev
```

## 构建

参阅 [tauri](https://tauri.app/zh/v1/guides/building/) 文档, 使用如下命令构建:

```bash
pnpm tauri build
```

## 协议

- [GPLv3](https://opensource.org/licenses/GPL-3.0)
59 changes: 59 additions & 0 deletions README_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# RWR Server ping

![license](https://badgen.net/github/license/Kreedzt/rwr-server-ping)
![latest release](https://badgen.net/github/release/Kreedzt/rwr-server-ping)
![commits count](https://badgen.net/github/commits/Kreedzt/rwr-server-ping)
![last commit](https://badgen.net/github/last-commit/Kreedzt/rwr-server-ping)

Quick query server status by rwr official url.

## Quick Start

Download latest [Release](https://github.com/Kreedzt/rwr-server-ping/releases), double-click exe to run app.

Available features:

- [x] Latency test
- [x] Join game / Copy join game command
- [x] Favorites

## Development

This project is based on [tauri](https://tauri.app/), depend on the following 2 language environments at the same time:

- [Nodejs](https://nodejs.org/en/)
- [Rust](https://www.rust-lang.org/)

After installing the environment, this project relies on `pnpm` for front-end package management

1. Install `pnpm`

```bash
npm i -g pnpm
```

2. Use `pnpm` install dependencies

```bash
pnpm i
```

3. Start development server

```
pnpm tauri dev
```

## Build

Refer to the [tauri](https://tauri.app/zh/v1/guides/building/) documentation, and use the following command to build.

```bash
pnpm tauri build
```

## License

- [GPLv3](https://opensource.org/licenses/GPL-3.0)


0 comments on commit c2c1669

Please sign in to comment.