Skip to content

Commit 5481d58

Browse files
committed
added setup script and readme updated
1 parent 70b2f40 commit 5481d58

3 files changed

Lines changed: 17 additions & 6 deletions

File tree

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"clean": "sh utils/scripts/clean.sh",
1313
"plugin": "sh utils/scripts/plugin.sh",
1414
"test": "jest",
15-
"build-ace": "node ./utils/build-ace.js"
15+
"build-ace": "node ./utils/build-ace.js",
16+
"setup": "sh utils/scripts/setup.sh"
1617
},
1718
"keywords": [
1819
"ecosystem:cordova"

readme.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src='res/logo_1.png' width='250'>
55
</p>
66

7-
Acode is a lightweight code editor for Android phones. You can use this editor for editing HTML, JavaScript, text.
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.
88

99
You can create a website, run the website in the browser and see errors or logs in the console.
1010
Also edit any kind of source file like python, CSS, HTML, Java, JavaScript, Dart, etc.
@@ -15,9 +15,15 @@ Also edit any kind of source file like python, CSS, HTML, Java, JavaScript, Dart
1515

1616
## Project structure
1717

18-
- `src` (directory) contains all raw codes
19-
- `www` (directory) contains public documents, built javascript and CSS files, language files, and HTML files
20-
- `utils` (directory) contains the CLI tool to manipulate or add strings to all languages easily
18+
<pre>
19+
Acode/
20+
|
21+
|- src/ - contains all the raw code
22+
|
23+
|- www/ - contains public documents, built JavaScript and CSS files, language files, and HTML files
24+
|
25+
|- utils/ - contains the CLI tools for building the package, manipulating/adding strings to all languages etc.
26+
</pre>
2127

2228
## Multi-language support
2329

@@ -36,7 +42,7 @@ yarn lang update
3642

3743
To build the APK you need Nodejs, NPM, and Apache Cordova installed on your device. Use Cordova CLI to build the application.
3844

39-
Run `npm install` to install all dependencies before building the APK.
45+
Run `yarn install` to setup the project before building the APK.
4046

4147
`yarn build <platform (android)> <free|paid> <p|prod|d|dev>`
4248

utils/scripts/setup.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
echo "Setting up the project..."
2+
3+
npm install
4+
mkdir -p www/css/build www/js/build

0 commit comments

Comments
 (0)