From c7c93c15d120afd31a6c748e84796a1c5fa530fa Mon Sep 17 00:00:00 2001 From: altaf-creator <64111012+altaf-creator@users.noreply.github.com> Date: Sun, 19 Mar 2023 13:17:26 +0700 Subject: Update README.md --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1c6ea4c..8acda31 100644 --- a/README.md +++ b/README.md @@ -1 +1,60 @@ -# MarkdownEditor \ No newline at end of file +# MarkdownEditor - a basic markdown viewer and editor + + + +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 +Open the shortcut named `MarkdownEditor` +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 `\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/). -- cgit v1.2.3 From b79db20d09d5f282da66997212e61ee807b15fad Mon Sep 17 00:00:00 2001 From: altaf-creator <64111012+altaf-creator@users.noreply.github.com> Date: Sun, 19 Mar 2023 13:19:12 +0700 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8acda31..cca7661 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ or navigate to `/bin/`, then open `MarkdownEditor.exe` 4. Click "Clone" 5. Change debugging target to "x64" 5. Click "â–ļ MarkdownEditor" to compile -6. The compiled build will be located at `\bin\x64\Debug\net48\MarkdownEditor.exe`. +6. The compiled build will be located at `\MarkdownEditor\bin\x64\Debug\net48\MarkdownEditor.exe`. ## Credits - [CefSharp](https://github.com/cefsharp/CefSharp) - chromium wrapper -- cgit v1.2.3 From f0f167afe61f444ca65fd947a7b0cc1d8f8fd481 Mon Sep 17 00:00:00 2001 From: altaf-creator <64111012+altaf-creator@users.noreply.github.com> Date: Sun, 19 Mar 2023 19:21:36 +0700 Subject: Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index cca7661..414d5e8 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,9 @@ Hello, World! MarkdownEditor is a markdown viewer and editor with all of the ess ## Installation > NOTE: Currently only available for Windows 64-bit ### Download from Releases -Open the shortcut named `MarkdownEditor` -or navigate to `/bin/`, then open `MarkdownEditor.exe` +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 -- cgit v1.2.3 From b8b2060d7ea3af082e313003c4bbc014ebd591c8 Mon Sep 17 00:00:00 2001 From: altaf-creator <64111012+altaf-creator@users.noreply.github.com> Date: Sun, 26 Mar 2023 19:27:04 +0700 Subject: Fix Icon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 414d5e8..e3bfe79 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MarkdownEditor - a basic markdown viewer and editor - + 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). -- cgit v1.2.3