Skip to content

Commit 5323182

Browse files
committed
your minor update message
1 parent 5bd4770 commit 5323182

1 file changed

Lines changed: 44 additions & 5 deletions

File tree

README.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## *Easyeditor* 🚀
22

3+
4+
5+
[🏠 Home](https://easyeditor.co.uk/) | [💻 Code](https://github.com/gcclinux/easyeditor.git) | [🌐 WebApp](https://easyedit-cloud.web.app/)
6+
37
**The Ultimate Real-Time Markdown Editor for Professionals, Developers & Writers**
48

59
Easyeditor is not just another Markdown editor—it's a **powerhouse** for your documentation needs. Write Markdown (MD), create stunning diagrams with **Mermaid** & **UML**, render mathematical equations with **KaTeX**, and preview it all in **real-time**!
@@ -39,7 +43,7 @@ Prefer a containerized environment? getting up and running is as simple as one c
3943
```bash
4044
# Pull and run the latest version
4145
docker pull ghcr.io/gcclinux/easyeditor:latest
42-
docker run -d --name EASYEDITOR -p 3024:3024 ghcr.io/gcclinux/easyeditor:main
46+
docker run -d --name EASYEDITOR -p 3024:3024 ghcr.io/gcclinux/easyeditor:latest
4347
```
4448
*Access it at: `http://localhost:3024`*
4549

@@ -80,17 +84,22 @@ npm run app
8084
To build the native desktop application provided by Tauri:
8185

8286
**First, set up your environment:**
87+
88+
* **All Platforms**: Install Visual Studio Code, Kiro, Antigravity, VSCodium or any other prefered IDE
8389
* **Linux**: Install `libwebkit2gtk-4.1-dev`, `build-essential`, `curl`, `wget`, `libssl-dev`, `libayatana-appindicator3-dev`, `librsvg2-dev`.
84-
* **Windows**: Install Visual Studio Build Tools with C++ workload.
90+
* **Windows**: Install additional extention C++ workload would help.
8591
* **macOS**: `xcode-select --install`
8692

8793
**Then run:**
8894
```bash
8995
# Development
90-
npm run tauri:dev
96+
npm run dev
9197

9298
# Production Build
93-
npm run tauri:build
99+
scripts\build-tauri.bat
100+
scripts\build-snap.sh
101+
scripts\build-docker.sh
102+
npm run tauri:build `**Linux Specific**`
94103
```
95104

96105
---
@@ -113,7 +122,7 @@ Visualize your ideas with **Mermaid** charts and **KaTeX** equations.
113122

114123
<a><img src="screenshots\KaTeX-example-online.png" alt="Online Templates" width="720" height="400"></a>
115124

116-
### 🐙 Git Integration
125+
### 🐙 EasyGit Integration
117126
Seamlessly manage your version control without leaving the editor.
118127

119128
<a><img src="screenshots/git_feature.png" alt="Git Feature" width="720" height="400"></a>
@@ -130,6 +139,36 @@ Clean and responsive table rendering.
130139

131140
---
132141

142+
143+
## *License*
144+
This project is licensed under the Open Source (MIT) license with Commons Clause and Trademark Protection.
145+
146+
### *What this means:*
147+
148+
✅ Open Source - Anyone can view, modify, and use the code
149+
✅ Community Contributions - Improvements must be shared back
150+
✅ Free to Use - No cost for personal or internal use
151+
❌ No Commercial Sale - Cannot sell EasyEditor or derivatives
152+
❌ No Rebranding - Cannot rebrand as "EasyEditor Pro" or similar
153+
❌ No Proprietary Forks - Cannot create closed-source versions
154+
155+
### *You can:*
156+
157+
Use Easyeditor for any purpose (free)
158+
Modify the code for your needs
159+
Use it in your projects (non-commercially)
160+
Distribute modified versions (non-commercially, with attribution)
161+
Contribute improvements back to the project
162+
163+
### *You cannot:*
164+
165+
Sell Easyeditor or any derivative
166+
Offer Easyeditor as a paid service
167+
Charge for hosting or support
168+
Rebrand it as your own product
169+
Create proprietary versions
170+
Remove attribution or license notices
171+
133172
## *Quick Links*
134173

135174
[![Home](https://img.shields.io/badge/🏠_Home-Visit_Site-blue?style=for-the-badge)](https://www.easyeditor.co.uk)

0 commit comments

Comments
 (0)