summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 61 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1c6ea4c..e3bfe79 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,61 @@
-# MarkdownEditor \ No newline at end of file
+# MarkdownEditor - a basic markdown viewer and editor
+
+<img src="/MarkdownEditor/icon_markdowneditor.png" width="400px" align="right">
+
+Hello, World! MarkdownEditor is a markdown viewer and editor with all of the essential features.
+> Note: MarkdownEditor is currently only available for Windows (64-bit).
+
+## Features
+- All markdown features, except:
+ - Definition List
+ - Emojis
+- Built-in directory file viewer
+- (almost) Real-time preview
+- Export to HTML (without CSS)
+- Open folders
+- Lightweight
+
+## Screenshots
+
+![screenshot1](https://i.imgur.com/tk6emRx.png)
+
+![screenshot2](https://i.imgur.com/b6rsFat.png)
+
+![screenshot3](https://i.imgur.com/tGq2Nlr.png)
+
+![screenshot4](https://i.imgur.com/t8Pedm4.png)
+
+## Usage
+- 💾: Save
+- 💾, but blue: Save As
+- 📤: Export to HTML
+- 📂: Open
+- đŸ—ƒī¸: Open Folder
+- â„šī¸: About
+
+## Installation
+> NOTE: Currently only available for Windows 64-bit
+### Download from Releases
+1. Unzip the file
+2. Open the shortcut named `MarkdownEditor`
+3. or navigate to `/bin/`, then open `MarkdownEditor.exe`
+
+### Compile using Visual Studio
+1. Open Visual Studio
+2. Click "Clone Repository" below "Get Started" section
+3. Copy and Paste this link [https://github.com/altaf-creator/MarkdownEditor](https://github.com/altaf-creator/MarkdownEditor) into the "Repository Location" text box.
+4. Click "Clone"
+5. Change debugging target to "x64"
+5. Click "â–ļ MarkdownEditor" to compile
+6. The compiled build will be located at `\MarkdownEditor\bin\x64\Debug\net48\MarkdownEditor.exe`.
+
+## Credits
+- [CefSharp](https://github.com/cefsharp/CefSharp) - chromium wrapper
+- [Markdig](https://github.com/xoofx/markdig) - markdown parser
+- [Ookii Dialogs](https://github.com/ookii-dialogs/ookii-dialogs-wpf) - open folder dialog
+- .NET C# WPF
+- Visual Studio 2022
+
+---
+
+Licensed under the [MIT License](https://mit-license.org/).