Skip to content
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

README update for the changes undergone #1030

Closed
wants to merge 7 commits into from
Closed

README update for the changes undergone #1030

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ca6fcd
Updated README
niccolopaganini Sep 12, 2023
6822c67
multiple changes: 1. structure/ flow 2. added contents section 3. upd…
niccolopaganini Sep 23, 2023
8ea506d
build successful screenshot
niccolopaganini Sep 23, 2023
ed0e871
Update README.md
niccolopaganini Sep 23, 2023
54656b8
Update README.md
niccolopaganini Sep 23, 2023
290dcc5
Update README.md
niccolopaganini Sep 23, 2023
809fc5d
Update README.md
niccolopaganini Sep 23, 2023
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
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ Installing (one time only)
---
Run the setup script for the platform you want to build

Make sure you switch to the "label_dashboard_profile_sept_2023" branch
```
git checkout label_dashboard_profile_sept_2023
```

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The label_dashboard_profile_sept_2023 branch is a temporary one that we are using for the current release.
It will be deleted after the release is moved to production.

$ bash setup/setup_android_native.sh
AND/OR
Expand All @@ -156,14 +161,6 @@ $ cp www/json/startupConfig.json.sample www/json/startupConfig.json
$ cp ..... www/json/connectionConfig.json
```

### Activation (after install, and in every new shell)

```
$ source setup/activate_native.sh
```

### Activation (after install, and in every new shell)

Comment on lines -159 to -166
Copy link
Contributor

@shankari shankari Sep 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you remove this? I believe we do need to activate after install. How did you test this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to build the app successfully. Let me verify the above again just to be sure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

were you able to build the app starting in a new terminal and following the instructions in the README exactly?
When you check, please show, don't tell.

If connecting to a development server over http, make sure to turn on http support on android

```
Expand All @@ -174,10 +171,15 @@ If connecting to a development server over http, make sure to turn on http suppo

### Run in the emulator

Pick a version and execute the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that "type of build" == "version"

Suggested change
Pick a version and execute the following:
Pick a type of build and execute the following:

You should also indicate how people can find the valid "type of build" supported.


```
$ npx cordova emulate ios
AND/OR
$ npx cordova emulate android
$ npm run <type_of_build>
```

For instance: (build-dev-android)
```
$ npm run build-dev-android
```

Creating logos
Expand Down