init

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 HereIsLz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,42 @@
-# Fluent-Typora
-This is a theme carefully crafted & designed for modern computer screens, inspired by Microsoft Fluent Design System.
+# Fluent
+
+## Info
+
+This is a theme carefully crafted & designed for modern computer screens, inspired by [Microsoft Fluent Design System](https://developer.microsoft.com/en-us/fluentui#/).
+
+ ![fluent](/fluent/main.png)
+
+
+
+## ⚠ Alert
+
+To speed up rendering, it is suggested to **download all the fonts and install them on your system**. (Hence no font was included in the theme package. If the theme was used in your system without the fonts below installed, your document would be rendered with default font.)
+
+Fontfaces you should install before fully utilizing this theme:
+
+- [Inter](https://github.com/rsms/inter/releases/download/v3.15/Inter-3.15.zip), provided in github repo.
+- [Jetbrains Mono](https://download.jetbrains.com/fonts/JetBrainsMono-1.0.3.zip), provided in github repo.
+- [思源黑体 CN](https://www.onlinedown.net/download/1122151?module=download) (**Only if you need support for Chinese.**)
+- 思源宋体 CN (**Optional. Only if you need support for Chinese.**)
+
+
+
+## Language Supported
+
+English, 简体中文
+
+
+
+## Tricky Escapings
+
+Some escapings was implemented with css:
+
+- Bold text in h5 (example: `##### **12** What does fluent mean?`) would be rendered like this: 
+
+  ![escaping1](fluent/escaping1.png)
+
+  It might be useful in your homework. 😆
+
+- h4, h5, h6 in blockquotes would be rendered with an icon before the text:
+
+  ![escaping1](/fluent/escaping2.png)