Skip to content

Commit

Permalink
📃 docs(README): 修正错误和不符合人类理解的话语
Browse files Browse the repository at this point in the history
  • Loading branch information
ClarkQAQ committed Jun 11, 2024
1 parent f38bb09 commit dd5b091
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 19 deletions.
23 changes: 14 additions & 9 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
<p align="center">
<h3 align="center">Restory</h3>
<p align="center">
Re (store + (hi) story) VSCode History Recovery Tool
Re (store + (hi) story) Based on VSCode History File Recovery Tool (and directory structure)
<br />
基于 VSCode 历史记录的文件 (包括目录结构) 恢复工具
</p>
</p>

> Are you using VSCode and accidentally deleted your folder? Restory can help you recover it!
[中文 README](README.md)

> Are you using VSCode but accidentally deleted some of your files and folders? Too lazy to find each historical record one by one? Restory can help you restore the entire directory with one click!
### Principle

This is a very simple tool. Restory scans the file modification history files of VSCode to obtain information, and rebuilds the directory structure and file content at the location you specify.
Unfortunately, you cannot use Restory to recover files that were not modified through VSCode, as VSCode does not generate the corresponding modification history files.

**Unfortunately, files that were not modified through VSCode cannot be recovered using Restory, as VSCode does not generate the corresponding modification history files.**

### Usage

Expand All @@ -26,13 +31,13 @@ $ ./restory_linux_amd64 ~/.config/Code/User/History /tmp/code-history

The VSCode history folder is usually located at `~/.config/Code/User/History` on Linux and `C:\Users\[your username]\AppData\Local\Code\User\History` on Windows.

[Windows Download](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_windows_amd64.exe)
[Linux Download](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_linux_amd64)
[MacOS Download](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_darwin_amd64)
### Quick Release Downloads

- [Windows Download Link](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_windows_amd64.exe)
- [Linux Download Link](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_linux_amd64)
- [MacOS Download Link](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_darwin_amd64)

### Finally

Please remember to back up your important files regularly! Upload them to Git timely!
This tool might help you once, but it cannot guarantee to help you every time...

---
This tool might help you once, but it cannot guarantee to help you every time...
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
<p align="center">
<h3 align="center">Restory</h3>
<p align="center">
Re (store + (hi) story) VSCode 历史记录文件恢复工具
Re (store + (hi) story) 基于 VSCode 历史记录的文件 (包括目录结构) 恢复工具
<br />
VSCode History Recovery Tool
Based on VSCode History File Recovery Tool (and directory structure)
</p>
</p>

[English README](README.en.md)

> 你在使用 VSCode,你的文件夹不小心删掉了? Restory 就能帮你恢复!
> 你在使用 VSCode,但是你的一些文件和文件夹不小心删掉了? 懒得一个个去找历史记录? Restory 能帮你一键恢复整个目录!
### 原理

这是一个很简单的工具. Restory 通过扫描 VSCode 的文件修改历史文件获取信息, 并在你指定的位置重建文件夹目录结构和文件内容。
很不幸的是, 你没有经过 VSCode 无法使用 Restore 恢复, 因为 VSCode 并没有产生对应的修改历史文件。
这是一个很简单的工具. Restory 通过扫描 VSCode 的文件修改历史文件获取信息, 并在你指定的位置重建文件夹目录结构和文件内容.

**很不幸的是, 你没有经过 VSCode 修改的文件无法使用 Restore 恢复, 因为 VSCode 并没有产生对应的修改历史文件.**

### 使用

Expand All @@ -31,11 +31,13 @@ $ ./restory_linux_amd64 ~/.config/Code/User/History /tmp/code-history

VSCode 历史文件夹目录在 Linux 平台通常是 `~/.config/Code/User/History`, Windows 平台则是 `C:\Users\[你的用户名]\AppData\Local\Code\User\History`.

[Windows 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_windows_amd64.exe)
[Linux 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_linux_amd64)
[MacOS 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_darwin_amd64)
### Release 快速下载

- [Windows 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_windows_amd64.exe)
- [Linux 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_linux_amd64)
- [MacOS 下载链接](https://github.com/ClarkQAQ/restory/releases/latest/download/restory_darwin_amd64)

### 最后

以后请多备份自己的重要文件! 及时上传到 Git!
或许我的这个工具能帮助你一次, 但是不能保证每一次都能帮助你...
以后请多备份自己的重要文件! 及时上传到 Git!
或许我的这个工具能帮助你一次, 但是不能保证每一次都能帮助你...

0 comments on commit dd5b091

Please sign in to comment.