|
| 1 | + |
1 | 2 | <div align="center">
|
2 | 3 |
|
3 | 4 | # Code Editor
|
|
14 | 15 | You have to make sure that you already have, atleast basic knowledge of terminal.
|
15 | 16 | - [A Journey To Cli](https://www.geeksforgeeks.org/linux-tutorial/)
|
16 | 17 | - [A Basic Understanding Of Commands](https://www.geeksforgeeks.org/basic-linux-commands/)
|
| 18 | + |
17 | 19 | ## Badges
|
18 | 20 | 
|
19 | 21 |
|
20 | 22 | 
|
21 | 23 |
|
22 |
| -## Documentation |
23 |
| -To access code-editor you can see the documentation here for now. [Click Here!](https://github.com/My-CodeDefense/code-editor) |
24 | 24 |
|
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. |
26 | 51 | ```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 |
28 | 53 | ```
|
29 | 54 |
|
| 55 | +Create a soft link of essential files for the code-editor. |
30 | 56 | ```bash
|
31 | 57 | ln -sf ~/.code-editor/src ~/.config/nvim
|
32 | 58 | ```
|
33 | 59 |
|
| 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 | + |
34 | 66 | ## Contributing
|
35 | 67 | Contributions are always welcome!
|
36 | 68 |
|
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