From 39584c6b254618123c681281312e171f01257731 Mon Sep 17 00:00:00 2001 From: Marcel Stevano Date: Fri, 18 Sep 2026 16:08:15 +0700 Subject: [PATCH 1/2] Enhance README with detailed features and structure Expanded the overview section to include details about the underlying technology and editions. Added new features related to the editor core, preview & debugging, terminal & servers, connectivity & sync, extensibility, and build variants. Updated project structure and multi-language support sections. --- readme.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 70 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index ca6991240..7f1bbb3bd 100644 --- a/readme.md +++ b/readme.md @@ -8,17 +8,43 @@ ## • Overview -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. +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. Under the hood it runs on Cordova with the Ace editor engine, and it ships as two editions from one codebase — free and Pro (unlocked via in-app purchase) — with a separate F-Droid build that strips out proprietary dependencies. ## • Features -- Edit and create websites, and instantly preview them in a browser. -- Seamlessly modify source files for various languages like Python, Java, JavaScript, and more. -- Built-in javascript console -- S/FTP and SSH terminal integration -- Built-in terminal(Alpine) -- Enjoy multi-language editing support with easy management tools. -- Enjoy a large collections of community plugins to enhance your coding experience. +**Editor core** +- Ace-based editor with syntax highlighting for 100+ programming and markup languages +- Dozens of built-in colour themes, plus a font manager for installing and using custom fonts +- Command Palette (`Ctrl+Shift+P`) and full keyboard-shortcut support (`Ctrl+S` to save, and more) for external/Bluetooth keyboards +- Fast fuzzy file finder (`Ctrl+P`) with startup file caching for instant results, even in large projects +- Search & replace across every file in a project, not just the open one +- Customizable Quick Tools row above the keyboard +- Local word completion — autocomplete suggestions drawn from the current file +- Rename, move, and manage files directly from the in-app file browser + +**Preview & debugging** +- Edit and create websites, and instantly preview them in a browser +- In-app Markdown preview +- Built-in JavaScript console + +**Terminal & servers** +- Built-in terminal (Alpine) with its own terminal service that can keep running in the background, independent of the app's lifecycle +- Multiple terminal tabs, `.initrc` support for custom shell startup, and pre-installed CLI tools such as `fd`, `rg` (ripgrep), `fzf`, and `jq` +- S/FTP and SSH terminal integration, including ED25519 key support, with resilient connection handling for stalled connections + +**Connectivity & sync** +- GitHub integration for syncing projects, including previewing files by GitHub URI +- Acode account/cloud sync for purchases and settings across devices + +**Extensibility** +- Enjoy a large collection of community plugins, backed by a first-party Plugin Store — 30+ plugins and growing, each showing version and last-updated info +- Plugin API that exposes editor internals so plugins can extend the editor deeply +- Multi-language editing support with easy management tools + +**Everything else** +- System-theme-aware UI (follows your device's light/dark setting) +- In-app sponsor page for supporting development +- Nightly builds published automatically via CI for the newest fixes ahead of stable releases ## • Installation @@ -26,18 +52,43 @@ You can get Acode Editor from popular platforms: [Get it on Google Play](https://play.google.com/store/apps/details?id=com.foxdebug.acodefree) [Get it on F-Droid](https://www.f-droid.org/packages/com.foxdebug.acode/) +You can also grab manual APKs, including automated nightly pre-releases, from [GitHub Releases](https://github.com/Acode-Foundation/Acode/releases). + ## • Project Structure 
 Acode/
 |
-|- src/   - Core code and language files
+|- .devcontainer/ - Pre-configured dev container for a ready-to-code environment
+|
+|- .github/       - CI workflows (build, translation checks, nightly releases)
+|
+|- hooks/         - Cordova build hooks
+|
+|- src/           - Core code and language files
 |
-|- www/   - Public documents, compiled files, and HTML templates
+|- www/           - Public documents, compiled files, and HTML templates
 |
-|- utils/ - CLI tools for building, string manipulation, and more
+|- utils/         - CLI tools for building, string manipulation, and more
+|
+|- tests/         - Test suite
+## • Build Variants + +Acode is built from one codebase into several variants using the project's build script: + +```shell +yarn build [fdroid] +``` + +- `free` / `paid` — selects the edition (paid unlocks Pro features via in-app purchase) +- `p`/`prod` or `d`/`dev` — production or development build +- `fdroid` (optional flag) — produces the F-Droid-compatible build with proprietary dependencies removed; omit it for the regular Play Store build +- `apk` or `bundle` — output format + +See [CONTRIBUTING.md](CONTRIBUTING.md) for full environment setup and build instructions. + ## • Multi-language Support 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/Acode-Foundation/Acode/tree/main/src/lang) and include it in [`src/lib/lang.js`](https://github.com/Acode-Foundation/Acode/blob/main/src/lib/lang.js). Manage strings across languages effortlessly using utility commands: @@ -49,6 +100,8 @@ pnpm run lang search pnpm run lang update ``` +Every pull request touching `src/lang/*.json` is automatically checked by CI for structural consistency before it can be merged. + ## • Contributing & Building the Application See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions. @@ -65,6 +118,12 @@ For comprehensive documentation on creating plugins for Acode Editor, visit the For plugin development information, refer to: [Acode Plugin Documentation](https://docs.acode.app/) +## • Community + +- [Telegram](https://t.me/foxdebug_acode) +- [Discord](https://discord.gg/vVxVWYUAWD) +- [GitHub Discussions](https://github.com/Acode-Foundation/Acode/discussions) + ## Star History From 131d6c46035537a6d672398f25524abc4166cb51 Mon Sep 17 00:00:00 2001 From: Marcel Stevano Date: Fri, 18 Sep 2026 16:31:49 +0700 Subject: [PATCH 2/2] Revise README fix: correct editor engine, GitHub sync claim, terminal filename, and build variant docs --- readme.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index 7f1bbb3bd..f35e5a05e 100644 --- a/readme.md +++ b/readme.md @@ -8,18 +8,18 @@ ## • Overview -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. Under the hood it runs on Cordova with the Ace editor engine, and it ships as two editions from one codebase — free and Pro (unlocked via in-app purchase) — with a separate F-Droid build that strips out proprietary dependencies. +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. Under the hood it runs on Cordova with a CodeMirror 6 editor engine (exposed to plugins through an Ace-compatible API layer), and it ships as two editions from one codebase - free and Pro (unlocked via in-app purchase) - with a separate F-Droid build that strips out proprietary dependencies. ## • Features **Editor core** -- Ace-based editor with syntax highlighting for 100+ programming and markup languages +- CodeMirror 6-based editor with syntax highlighting for 100+ programming and markup languages - Dozens of built-in colour themes, plus a font manager for installing and using custom fonts - Command Palette (`Ctrl+Shift+P`) and full keyboard-shortcut support (`Ctrl+S` to save, and more) for external/Bluetooth keyboards - Fast fuzzy file finder (`Ctrl+P`) with startup file caching for instant results, even in large projects - Search & replace across every file in a project, not just the open one - Customizable Quick Tools row above the keyboard -- Local word completion — autocomplete suggestions drawn from the current file +- Local word completion - autocomplete suggestions drawn from the current file - Rename, move, and manage files directly from the in-app file browser **Preview & debugging** @@ -29,15 +29,15 @@ Welcome to Acode Editor - a powerful and versatile code editing tool designed sp **Terminal & servers** - Built-in terminal (Alpine) with its own terminal service that can keep running in the background, independent of the app's lifecycle -- Multiple terminal tabs, `.initrc` support for custom shell startup, and pre-installed CLI tools such as `fd`, `rg` (ripgrep), `fzf`, and `jq` +- Multiple terminal tabs, `/initrc` support for custom shell startup, and pre-installed CLI tools such as `fd`, `rg` (ripgrep), `fzf`, and `jq` - S/FTP and SSH terminal integration, including ED25519 key support, with resilient connection handling for stalled connections **Connectivity & sync** -- GitHub integration for syncing projects, including previewing files by GitHub URI -- Acode account/cloud sync for purchases and settings across devices +- Acode account for restoring purchase entitlement across devices +- Manual settings backup and restore **Extensibility** -- Enjoy a large collection of community plugins, backed by a first-party Plugin Store — 30+ plugins and growing, each showing version and last-updated info +- Enjoy a large collection of community plugins, backed by a first-party Plugin Store - 30+ plugins and growing, each showing version and last-updated info - Plugin API that exposes editor internals so plugins can extend the editor deeply - Multi-language editing support with easy management tools @@ -82,10 +82,10 @@ Acode is built from one codebase into several variants using the project's build yarn build [fdroid] ``` -- `free` / `paid` — selects the edition (paid unlocks Pro features via in-app purchase) -- `p`/`prod` or `d`/`dev` — production or development build -- `fdroid` (optional flag) — produces the F-Droid-compatible build with proprietary dependencies removed; omit it for the regular Play Store build -- `apk` or `bundle` — output format +- `free` / `paid` - selects the build artifact: the `paid` build unlocks Pro features directly, with no purchase required for that package. An in-app purchase is a separate upgrade path that unlocks Pro inside the `free` package +- `p`/`prod` or `d`/`dev` - production or development build +- `fdroid` (optional flag) - produces the F-Droid-compatible build with proprietary dependencies removed; omit it for the regular Play Store build +- `apk` or `bundle` - output format See [CONTRIBUTING.md](CONTRIBUTING.md) for full environment setup and build instructions.