Skip to content

Commit c618d2b

Browse files
committed
Update readme.md
1 parent 02424ad commit c618d2b

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

readme.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
<a href="https://acode.app/plugin/bajrangcoder.acodex"><img alt="Download Counts" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Facode.app%2Fapi%2Fplugin%2Fbajrangcoder.acodex&query=downloads&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IiNjYWQzZjUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBjbGFzcz0ibHVjaWRlIGx1Y2lkZS1hcnJvdy1kb3duLXRvLWxpbmUiPjxwYXRoIGQ9Ik0xMiAxN1YzIi8+PHBhdGggZD0ibTYgMTEgNiA2IDYtNiIvPjxwYXRoIGQ9Ik0xOSAyMUg1Ii8+PC9zdmc+&logoColor=cad3f5&label=Downloads&labelColor=363a4f&color=c6a0f6"></a>
88
</p>
99

10-
> [!CAUTION]
11-
> Ai functionality is not working entirely, soon it will be patched
12-
1310
> [!Warning]
1411
> This plugin requires the [acodex-server](https://github.com/bajrangCoder/AcodeX-server) NodeJS package or [axs](https://github.com/bajrangCoder/acodex_server) to be installed and running on [Termux](https://termux.dev).
1512
@@ -50,7 +47,7 @@
5047
- fixed some bugs related to disposing of terminal reported by Users
5148
- Added font ligatures support (you can disable it from settings)
5249
- fix: ctrl - k issue when terminal is minimised or opened
53-
- now ctrl-k can also be used as shortcut to maximise terminal if it is open and minimised
50+
- now ctrl-k can also be used as shortcut to maximise terminal if it is open and minimised
5451
- new settings to on/off haptic(vibration) on Selection start
5552
- some minor fixes and few typos adjustments
5653

@@ -59,13 +56,13 @@
5956

6057
> For previous change logs/updates, visit: [Change Log](https://github.com/bajrangCoder/acode-plugin-acodex/blob/main/ChangeLog.md)
6158
62-
### Roadmap
59+
### Roadmap
6360

6461
- Add shortcuts for minimising and also refine other shortcuts
6562
- full page mode for AcodeX similar to other terminal plugins (using Acode tab view)
6663
- fix bugs related to touch selection and gui viewer
67-
- ssh based Terminal support
68-
- config(dotfiles) for acodex to customise everything from the config file
64+
- ssh based Terminal support
65+
- config(dotfiles) for acodex to customise everything from the config file
6966
- suggest more 🙌
7067

7168
## 💥 Features
@@ -115,11 +112,11 @@ To use AcodeX, you need to have the [Termux app](https://termux.dev/en/) install
115112

116113
## Installation
117114

118-
1. **Install the Plugin in Acode**
119-
Open the Acode App and navigate to:
115+
1. **Install the Plugin in Acode**
116+
Open the Acode App and navigate to:
120117
`Acode > Settings > Plugins > AcodeX`, then install the plugin.
121118

122-
2. **Install the Server in Termux**
119+
2. **Install the Server in Termux**
123120
To install everything required, including prompts for GUI-related tools like TigerVNC and Websockify (if needed), run the following command in Termux:
124121

125122
```bash
@@ -154,7 +151,7 @@ To use AcodeX, you need to have the [Termux app](https://termux.dev/en/) install
154151

155152
If you're an existing user and want to start using the new GUI features, follow these steps to install the required packages:
156153

157-
1. **Install TigerVNC and Websockify**
154+
1. **Install TigerVNC and Websockify**
158155
Run the following commands in Termux to install the necessary packages:
159156

160157
```bash
@@ -163,7 +160,7 @@ If you're an existing user and want to start using the new GUI features, follow
163160
curl -L https://raw.githubusercontent.com/bajrangCoder/websockify_rs/main/install.sh | bash
164161
```
165162

166-
2. **Setup VNC Server**
163+
2. **Setup VNC Server**
167164
After installation, run the `vncserver` command for the first time to set up a password:
168165

169166
```bash
@@ -172,7 +169,7 @@ If you're an existing user and want to start using the new GUI features, follow
172169

173170
This will prompt you to create a password for your VNC server.
174171

175-
3. **Start Using GUI Features**
172+
3. **Start Using GUI Features**
176173
Once you’ve set up the VNC server, AcodeX will handle everything for you automatically, enabling the use of GUI apps seamlessly. but you will need to enable this feature from AcodeX settings.(after enabling you will get an image like icon on AcodeX header for viewing the gui)
177174

178175
## How to Use
@@ -182,7 +179,7 @@ If you're an existing user and want to start using the new GUI features, follow
182179
- Start the server in Termux using: `acodeX-server`.
183180
- To use AcodeX, press `Ctrl+K` or search for `"Open Terminal"` in the command palette (press `Ctrl+Shift+P` to open the command palette).
184181
- Enter the port number, and the terminal will start.
185-
- Plus `+` icon to create new session
182+
- Plus `+` icon to create new session
186183
- Use the minus icon button to hide the terminal while coding and the terminal button or `Ctrl-Shift-T` to show it.
187184
- You can also drag the terminal panel around by clicking and dragging through the terminal header area.
188185
- The `` button is for closing the terminal.
@@ -192,42 +189,42 @@ If you're an existing user and want to start using the new GUI features, follow
192189

193190
To run GUI apps within AcodeX, follow the steps below:
194191

195-
1. **Install the Required Packages**
192+
1. **Install the Required Packages**
196193
Ensure that you have installed the necessary packages by following the instructions in the [Installation](#installation) or [Existing Users Setup](#for-existing-users-enabling-gui-features) sections.
197194

198-
2. **Enable GUI Viewer Settings**
199-
- Navigate to `Acode > Settings > Plugins > AcodeX`.
200-
- Tap the ⚙️ icon at the top-right corner of the AcodeX header to access the plugin settings.
195+
2. **Enable GUI Viewer Settings**
196+
- Navigate to `Acode > Settings > Plugins > AcodeX`.
197+
- Tap the ⚙️ icon at the top-right corner of the AcodeX header to access the plugin settings.
201198
- Enable the **GUI Viewer** option from the settings.
202199

203-
3. **Open AcodeX Terminal**
200+
3. **Open AcodeX Terminal**
204201
- Open the AcodeX terminal using the `Ctrl+K` shortcut, or search for "Open Terminal" in the command palette.
205202

206-
4. **Launch the GUI Viewer**
207-
- In the terminal header, you'll see a small **image-like icon**.
208-
- Click the icon. The first time you do this, it will set up the necessary configurations and prompt you for the VNC password.
203+
4. **Launch the GUI Viewer**
204+
- In the terminal header, you'll see a small **image-like icon**.
205+
- Click the icon. The first time you do this, it will set up the necessary configurations and prompt you for the VNC password.
209206
- Enter your VNC password, which will be saved securely in the local storage for future sessions.
210207

211-
5. **Using the GUI Viewer**
208+
5. **Using the GUI Viewer**
212209
After setup, the GUI Viewer page will open. On this page, you’ll find multiple interactive elements such as:
213210

214-
- **Display Variable Button**:
215-
This button copies the `DISPLAY` environment variable needed for running GUI apps.
216-
211+
- **Display Variable Button**:
212+
This button copies the `DISPLAY` environment variable needed for running GUI apps.
213+
217214
**Before launching a GUI app**, always click the **Display Button** to set up the display environment in the terminal. If you skip this step, the GUI app will fail with a "No display variable" error.
218215

219-
- **Keyboard Icon**:
216+
- **Keyboard Icon**:
220217
A keyboard icon is available to activate your mobile keyboard for typing within GUI applications.
221218

222-
6. **Run Your GUI App**
223-
- In the AcodeX terminal, **click the Display button**, which will copy and execute the `export DISPLAY` command.
219+
6. **Run Your GUI App**
220+
- In the AcodeX terminal, **click the Display button**, which will copy and execute the `export DISPLAY` command.
224221
- Start your GUI app in the terminal, and it will open in the integrated viewer.
225222

226223
> [!TIP]
227224
> Always verify that the `export DISPLAY` command was executed successfully before launching your GUI application.
228-
225+
229226
> [!NOTE]
230-
> the display env variable command needs to run once in a terminal session
227+
> the display env variable command needs to run once in a terminal session
231228
232229
### Why is there no selection context menu?
233230

@@ -248,8 +245,8 @@ AcodeX provides some additional Keybindings for easy usability of terminal featu
248245
249246
Following are the supported Keybindings :
250247

251-
- <kbd>Ctrl+N</kbd> : opens a new terminal session
252-
- <kbd>Ctrl+W</kbd> : close opened terminal session
248+
- <kbd>Ctrl+N</kbd> : opens a new terminal session
249+
- <kbd>Ctrl+W</kbd> : close opened terminal session
253250
- <kbd>Ctrl+Shift+V</kbd> : paste something from clipboard inside your terminal
254251
- <kbd>Ctrl+Shift+C</kbd> : copy selected text from terminal
255252
- <kbd>Ctrl+Left Arrow</kbd> : open previous session corresponding to current one like if current one is session 2 then it will open session 1(if exists)
@@ -259,7 +256,7 @@ Following are the supported Keybindings :
259256
- <kbd>Ctrl+3</kbd> : opens session 3 if exists
260257
- <kbd>Ctrl+4</kbd> : opens session 4 if exists
261258
- <kbd>Ctrl+5</kbd> : opens session 5 if exists
262-
- <kbd>Ctrl+Shift+I</kbd> : clear the terminal
259+
- <kbd>Ctrl+Shift+I</kbd> : clear the terminal
263260
- <kbd>Ctrl+Shift+T</kbd> : Maximise the terminal *
264261
- <kbd>Ctrl+a</kbd> : select all
265262

@@ -417,7 +414,7 @@ acodex.applyTheme("myTheme");
417414

418415
## Custom Fonts
419416

420-
Custom fonts are provided to load any other external fonts
417+
Custom fonts are provided to load any other external fonts
421418

422419
To load a custom font:
423420

@@ -513,7 +510,7 @@ You can also support the development of AcodeX Plugin by making a financial cont
513510

514511
### ⭐ Star on GitHub
515512

516-
If you find AcodeX Plugin useful, consider giving it a star on GitHub. It's a simple way to show your appreciation and help others discover the project. and You can review AcodeX on https://acode.app
513+
If you find AcodeX Plugin useful, consider giving it a star on GitHub. It's a simple way to show your appreciation and help others discover the project. and You can review AcodeX on https://acode.app
517514

518515
Your contributions, whether through code, financial support, or a simple star, make AcodeX Plugin better for the entire community. Thank you for your support!
519516

0 commit comments

Comments
 (0)