Skip to content

Commit 5efc75a

Browse files
Improving the style of the readme (#796)
* Updating the readme: make it look more dynamic and attractive to the eyes! This readme is more complete than the old one, with more information about Acode and a great visual look! * Updating the readme: Making it more attractive to the eyes and with extra information! This readme is more complete than the old one, with more information about Acode and a great visual look!
1 parent 36c343c commit 5efc75a

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

readme.md

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,41 @@
1-
# Acode editor (Code editor for android)
1+
# Acode Editor - Code Editor for Android
22

3-
<p style='text-align:center;'>
4-
<img src='res/logo_1.png' width='250'>
3+
<p align="center">
4+
<img src='res/logo_1.png' width='250'>
55
</p>
66

7-
Acode is a lightweight but powerful code editor for Android phones. You can use this editor for editing HTML, CSS, JavaScript, text files, etc.
7+
## • Overview
88

9-
You can create a website, run the website in the browser and see errors or logs in the console.
10-
Also edit any kind of source file like Python, CSS, HTML, Java, JavaScript, Dart, etc.
9+
Welcome to Acode Editor - a powerful and versatile code editing tool designed specifically for Android devices. Whether you're working on HTML, CSS, JavaScript, or other programming languages, Acode empowers you to code on-the-go with confidence.
1110

12-
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
13-
alt="Get it on Google Play"
14-
height="80">](https://play.google.com/store/apps/details?id=com.foxdebug.acodefree)
15-
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
16-
alt="Get it on F-Droid"
17-
height="80" />](https://www.f-droid.org/packages/com.foxdebug.acode/)
11+
## • Features
1812

19-
## Project structure
13+
- Edit and create websites, and instantly preview them in a browser.
14+
- Seamlessly modify source files for various languages like Python, Java, JavaScript, and more.
15+
- Access the console to quickly identify errors and logs.
16+
- Enjoy multi-language editing support with easy management tools.
17+
18+
## • Installation
19+
20+
You can get Acode Editor from popular platforms:
21+
22+
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="60">](https://play.google.com/store/apps/details?id=com.foxdebug.acodefree) [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="60"/>](https://www.f-droid.org/packages/com.foxdebug.acode/)
23+
24+
## • Project Structure
2025

2126
<pre>
2227
Acode/
2328
|
24-
|- src/ - contains all the raw code, and language files
29+
|- src/ - Core code and language files
2530
|
26-
|- www/ - contains public documents, built JavaScript and CSS files, and HTML files
31+
|- www/ - Public documents, compiled files, and HTML templates
2732
|
28-
|- utils/ - contains the CLI tools for building the package, manipulating/adding strings to all languages, etc.
33+
|- utils/ - CLI tools for building, string manipulation, and more
2934
</pre>
3035

31-
## Multi-language support
36+
## Multi-language Support
3237

33-
To add a new language, create a new file with the language code for Android (e.g. en-us for English) in the [`src/lang/`](https://github.com/deadlyjack/Acode/tree/main/src/lang) directory. After adding your new language, also add it to [`src/lib/lang.js`](https://github.com/deadlyjack/Acode/blob/main/src/lib/lang.js).
34-
35-
Here are a few utility tools to add, remove or search a string in all added languages.
38+
Enhance Acode's capabilities by adding new languages easily. Just create a file with the language code (e.g., en-us for English) in [`src/lang/`](https://github.com/deadlyjack/Acode/tree/main/src/lang) and include it in [`src/lib/lang.js`](https://github.com/deadlyjack/Acode/blob/main/src/lib/lang.js). Manage strings across languages effortlessly using utility commands:
3639

3740
```shell
3841
yarn lang add
@@ -41,22 +44,26 @@ yarn lang search
4144
yarn lang update
4245
```
4346

44-
## How to build
47+
## • Building the Application
4548

46-
To build the APK you need Nodejs, NPM, and Apache Cordova installed on your device. Use Cordova CLI to build the application.
49+
To build the APK, ensure you have Node.js, NPM, and Apache Cordova installed on your device. Use Cordova CLI to build the application.
4750

48-
Run this command to do the initial setup of the project. It's required just once.
51+
1. Initial setup (required only once):
4952

5053
```shell
5154
yarn setup
5255
```
5356

54-
Build the project:
57+
2. Build the project:
5558

5659
```shell
5760
yarn build <platform (android)> <free|paid> <p|prod|d|dev>
5861
```
5962

60-
## Develop a plugin for Acode
63+
## • Developing a Plugin for Acode
64+
65+
For comprehensive documentation on creating plugins for Acode Editor, visit the [repository](https://github.com/deadlyjack/acode-plugin).
66+
67+
For plugin development information, refer to: [Acode Plugin Documentation](https://acode.foxdebug.com/plugin-docs)
6168

62-
Please see this [repository](https://github.com/deadlyjack/acode-plugin) for documentation.
69+
> 💙 Empower your coding journey with the dynamic and efficient Acode Editor. Happy coding on-the-go!

0 commit comments

Comments
 (0)