Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Updated #9

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Code Editor
This code-editor is a self suffient Code Editor which provide you an unbelievable experience in coding.
This Code Editor supports almost all the Major and minor languages which provide you the facility to code in all languages in a simple way.

## Features

<h3>Multi-Language Support</h3>
<br>
Supports over 80+ modern languages and almost all popular frameworks.
<br>
<br>

<h2 style = "color:#d96914;">For Intalling, Updating and Reseting Code Editor</h2>

You can use Guide for Detailed steps and links of Code Editor
[ Guide of Code Editor](languages.md)

## Modes in Code Editor
There are 3 Modes in Code Editor :-
1. Normal Mode
2. Insert Mode
3. Visual Mode

## Normal Mode

When You open the Code Editor, It always starts in Normal mode. In Normal Mode you can run commands & Shortcuts. For Command press colon : first.

Example for command
```
: exit
```
<hr>
#### Some Basic Comamnds in Normal Mode

| Command | Description |
| ----------- | ----------- |
| `F` | Fold the Selected Block |
|`ctrl + t`| Open Terminal |
|`ctrl + F`| fold All |
|`ctrl + J` | Unfold All |
|`ctrl + Q` | Close the File without Saving |
|`Alt + E` | Open File Manager |
|`Alt + R` | Run Code |
|`Alt + Q` | Close All Files |


For Split the terminal in 2 Vertical parts, run the following Commandand use one part as Code Editor and other as Code Terminal.

```bash
:Vertical terminal
```

Use the following syntax to Run Program on Terminal part.

`<Language_Name> <File_Name>`

Example :-
```python
python example.py
```

#### Normal Mode to Insert Mode
You can Switch to Insert Mode from Normal Mode by Pressing 'I'

## Insert Mode

In Insert Mode you can Edit, Modify and make changes to your Code.

### Some Basic Comamnds in Insert Mode

| Command | Description |
| ----------- | ----------- |
|`ctrl + D`| Duplicate Line |
|`ctrl + S` | Save |
|`ctrl + Q` | Save and Close File |
|`Ctrl + U`| Undo |
|`Ctrl + R` | Redo |
|`Ctrl + ↑` | Shift Code line Up|
|`Ctrl + ↓` | Shift Code Line Down |
|`Ctrl + C`| Copy |
|`Ctrl + V` | Paste |
87 changes: 87 additions & 0 deletions languages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Installing on Linux (Debian Based only)

This Documentation is only for Debian Based Linux.
<br>
Follow these Steps :-
<ol>
<li>Install Package</li>
<li>Files Clonning & Configuration</li>
<li>Installing Language Server</li>
</ol>

### Install Package

Write the following Command in Terminal
```bash
apt install git neovim nodejs
```

### Files Clonning & Configuration

``` bash
git clone ---depth=1 https://github.com/OurCodeBase/code-editor ~/.config/nvim
```
### Installing Language Server

```bash
LspInstall jedi_language_server
```

> [!CAUTION]
> If You use this code editor for Python, You need to run a command in Termux Terminal to install Python Server after Installing the Package
>

```bash
apt install python
```

<br>
<br>

# Update Code Editor

If u want to update the Editor, then Run the following Command in Terminal to get its lateat version.

```bash
cd ~/.config/nvim
git pull
```

> [!CAUTION]
> If Error Occurs run the following Command
>

```bash
git pull --force
```

<br>
<br>

# For Reset the Code Editor

If u have not updated your Code editor for a long...please Reset it with new updates.by us8ng following codes in terminal.

```bash
cd
rm -rf .config/nvim
rm -rf .local
git clone https://github.com/OurCodeBase/code-editor.git .config/
```

## How to Open a File in code-editor

In Termux window write the following query :-

`<Language_Name> <File_Name>`
<br>

Example :-
```python
python example.py
```

# Code Editor Modes

Click here to know more about modes
[Code Editor Modes](README.md)