编写Readme文件

LMSGuides助手-源码.user.js

@@ -1,5 +1,5 @@
 // ==UserScript==
-// @name         LMSGuides助手-源码
+// @name         LMSGuide辅助
 // @version      1.3.2
 // @description  要有远大的理想，也要有脚踏实地的本领
 // @author       小钊
@@ -12,16 +12,6 @@
 // @grant        GM_deleteValue
 // ==/UserScript==
 
-/* 更新日志
-1.3.1
-修复
-复制到实体机功能无法使用
-1.3.2
-修复 
-1.实验报告->文本样式->预定义格式被识别为代码导致添加按钮的bug
-2.复制到虚拟机/实体机成功的提示无法切换
-*/
-
 (function() {
     'use strict';
     // 通用样式定义
@@ -399,4 +389,4 @@
             }catch {}
         }
     }, 1000)
-})();
+})();

README.md

@@ -0,0 +1,26 @@
+# 项目介绍
+    本项目是针对LMS Guides 进行开发
+    能够将平台的复制限制进行解除，同时增加了一些辅助的功能，有：复制到虚拟机功能、复制到实体机功能、实验报告自动滚动到最下面
+# 环境依赖
+    script cat或篡改猴(篡改猴暂未测试，可能会出现一些问题，如出现问题可以提交issues)
+ 
+# 目录结构描述
+    ├── ReadMe.md           	  // 帮助文档
+    
+    ├── LMSGuides助手.user.js    // 辅助的源文件
+    
+    └── Scriptcat               // ScriptCat脚本管理器
+ 
+# 使用说明
+    浏览器添加script cat脚本管理器(或篡改猴)拓展，随后在拓展管理界面新增脚本，编辑脚本的@match地址，将其改为本校的平台地址。
+ 
+ 
+# 版本内容更新
+###### 1.3.1
+    修复
+    复制到实体机功能无法使用
+###### 1.3.2
+    修复
+    1.实验报告->文本样式->预定义格式被识别为代码导致添加按钮的bug
+    2.复制到虚拟机/实体机成功的提示无法切换
+