Skip to content

Commit 1b7747c

Browse files
authored
Revise README for Meridia V2 and installation details
Updated README to reflect changes in versioning and installation instructions.
1 parent 52d48db commit 1b7747c

File tree

1 file changed

+88
-6
lines changed

1 file changed

+88
-6
lines changed

README.md

Lines changed: 88 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
Development happens on v2 (branch).
1+
# Meridia V2 (Alpha)
22

3-
# Meridia
3+
## ⚠️ Important
44

5-
<img src="./resources/whole.png" style="border-radius: 8px" />
5+
- v2 branch → Complete core rewrite (Active development)
6+
- main branch → Stable V1 release
67

7-
Meridia is a next-gen code editor that blends coding, debugging, and customizable.
8+
![Meridia Preview](./public/preview/video/2026-03-01.gif)
9+
10+
Meridia is a modern code editor where you code, and AI collaborates — never takes control.
811

912
Visit [meridia.dev](https://meridia.dev) for more info.
1013

1114
# Documentation
1215

13-
If you want to read about using Meridia or developing extensions in Meridia, the [Documentation](https://docs.meridia.dev) is available.
16+
If you want to read about using Meridia or developing extensions in Meridia, the [Documentation](https://meridia.dev/docs) is available.
1417

15-
# Installing
18+
# Installation
1619

1720
## Prerequisites
1821

@@ -30,6 +33,85 @@ Download the latest [Meridia App Image](https://meridia.dev/download)
3033

3134
Meridia will automatically update when a new release is available.
3235

36+
# Installing Locally
37+
38+
## Prerequisites
39+
40+
- [Git](https://git-scm.com/)
41+
- [Node 20.x.x](https://nodejs.org/)
42+
- [Python 13+](https://python.org/)
43+
- [NPM or Yarn](https://npmjs.com/)
44+
- [Ollama](https://ollama.com/download) (optional, for AI features)
45+
46+
### Clone the repository (v2 branch)
47+
48+
```bash
49+
git clone https://github.com/ridit-jangra/Meridia -b v2
50+
cd Meridia
51+
```
52+
53+
### Install Dependencies
54+
55+
Using npm
56+
57+
```bash
58+
npm install
59+
```
60+
61+
Using yarn
62+
63+
```bash
64+
yarn install
65+
```
66+
67+
### Rebuild Native Modules
68+
69+
Using npm
70+
71+
```
72+
npm rebuild
73+
```
74+
75+
Using yarn
76+
77+
```bash
78+
yarn run rebuild
79+
```
80+
81+
### Run Development Mode
82+
83+
Using npm
84+
85+
```
86+
npm run dev
87+
```
88+
89+
Using yarn
90+
91+
```
92+
yarn dev
93+
```
94+
95+
### Build package
96+
97+
Using npm
98+
99+
```
100+
npm run build
101+
```
102+
103+
Using yarn
104+
105+
```
106+
yarn build
107+
```
108+
109+
# Contributing
110+
111+
Contributions are welcome.
112+
113+
Please read `CONTRIBUTING.md` before submitting a PR.
114+
33115
# License
34116

35117
[Mit](https://github.com/ridit-jangra/Meridia/blob/main/LICENSE)

0 commit comments

Comments
 (0)