Skip to content

docs: improve README #1

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.

Sign up for GitHub

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

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# CodeDroid — Mobile Code Execution Engine for Android & iOS

<p align="center">
Expand Down Expand Up @@ -384,9 +386,9 @@ For detailed configurations, see **[NETWORK_ACCESS.md](./docs/NETWORK_ACCESS.md)
```
* **Compiling Binary to Root (For Developers)**:
```bash
./run.sh --build
./build_api.sh
```
*This compiles the API and places it in the root for direct run.*
*This compiles the API, places the `codedroid-api` binary in the repository root, and starts the server.*
In another session, start the Trunk Web IDE specifying bindings:
```bash
cd codedroid_frontend && trunk serve --port 8082 --address 0.0.0.0
Expand Down Expand Up @@ -459,4 +461,4 @@ CodeDroid is licensed under the [GNU General Public License v3.0](LICENSE).
* **YouTube**: [Watch Video Guides & Features](https://www.youtube.com/@CodeDroidYT)

---
*CodeDroid — Because real developers code everywhere.*
*CodeDroid — Because real developers code everywhere.*