Skip to content

Commit 21fea0f

Browse files
authored
readme docs updated for providing wiki documentation.
1 parent 89e1d77 commit 21fea0f

File tree

1 file changed

+43
-5
lines changed

1 file changed

+43
-5
lines changed

docs/readme.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
<div align="center">
23

34
# Code Editor
@@ -14,24 +15,61 @@
1415
You have to make sure that you already have, atleast basic knowledge of terminal.
1516
- [A Journey To Cli](https://www.geeksforgeeks.org/linux-tutorial/)
1617
- [A Basic Understanding Of Commands](https://www.geeksforgeeks.org/basic-linux-commands/)
18+
1719
## Badges
1820
![ChipperCI](https://img.shields.io/badge/bsd_licensed-1e394e.svg?style=for-the-badge&logo=chipperci&logoColor=white)
1921

2022
![Fastlane](https://img.shields.io/badge/maintained-%2382bd4e.svg?style=for-the-badge&logo=fastlane&logoColor=black)
2123

22-
## Documentation
23-
To access code-editor you can see the documentation here for now. [Click Here!](https://github.com/My-CodeDefense/code-editor)
2424

25-
And if you are an experienced linux user just use these commands.
25+
## Installation
26+
27+
code-editor is based on `neovim` and it's language server protocol is installed and used through `nodejs` and `npm`. So you must have to install the dependencies.
28+
29+
### Install dependencies
30+
31+
If your device is non-rooted then use `sudo` infront of every command mentioned below. *`eg: apt install git nodejs neovim -y`*
32+
33+
| **Platform** | **Supported Package** | **Rooted** | **Command** |
34+
|:--------------------:|:---------------------:|:----------:|:---------------------------:|
35+
| Debian Based, Termux | deb || `apt install git nodejs neovim -y` |
36+
| RHEL Based | rpm || `dnf install git nodejs neovim -y` |
37+
| Arch Based | pkg.tar.zst || `pacman -S git nodejs neovim -y` |
38+
39+
### Check dependencies
40+
41+
Check that these packages are successfully installed or not using the following commands.
42+
43+
| **Packages** | **Command** | **Expected Results** |
44+
|:------------:|:-----------:|:--------------------:|
45+
| nodejs | `node -v` | v22.8.0 |
46+
| npm | `npm -v` | 10.8.2 |
47+
48+
### Finishing Up
49+
50+
Clone the entire repository.
2651
```bash
27-
git clone https://github.com/OurCodeBase/code-editor ~/.code-editor
52+
git clone --depth=1 https://github.com/OurCodeBase/code-editor ~/.code-editor
2853
```
2954

55+
Create a soft link of essential files for the code-editor.
3056
```bash
3157
ln -sf ~/.code-editor/src ~/.config/nvim
3258
```
3359

60+
## Documentation
61+
62+
The documentation contains every single details in brief explainations so we can't document that here.
63+
64+
You can read full documentation with docs, images and videos. [Click here to visit documentation.](https://github.com/OurCodeBase/code-editor/wiki)
65+
3466
## Contributing
3567
Contributions are always welcome!
3668

37-
Fork the repository and make pull requests, our team will approach you as soon as possible.
69+
You can access full source code inside `src` folder. Also, you must ensure the following rules to modify plugins.
70+
71+
- file names should not contain any symbol or capital letter.
72+
- the commit must explain every point of changes.
73+
- every changes should also be updated in documentation.
74+
75+
You're good to go, fork the repository and make pull requests, our team will approach you as soon as possible.

0 commit comments

Comments
 (0)