Skip to content

Commit 0d7d8bf

Browse files
committed
docs: updated readme for codacy errors
1 parent cde15d6 commit 0d7d8bf

File tree

1 file changed

+20
-29
lines changed

1 file changed

+20
-29
lines changed

README.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ This repository holds the Android App for performing experiments with [PSLab](ht
9898
</table>
9999

100100
## Video Demo
101-
- [PSLab Android App Overview](https://www.youtube.com/watch?v=JJfsF0b8M8k).
102-
- [Observing Sound Waveforms Using PSLab Device](https://www.youtube.com/watch?v=5bxDd1PiOMQ).
103-
- [Real-time Sensor Data Logging Using Pocket Science Lab](https://www.youtube.com/watch?v=_A8h6o-UcNo).
104-
- [Generating and Observing Waveforms Using Pocket Science Lab](https://www.youtube.com/watch?v=Ua9_OCR4p8Y).
101+
* [PSLab Android App Overview](https://www.youtube.com/watch?v=JJfsF0b8M8k).
102+
* [Observing Sound Waveforms Using PSLab Device](https://www.youtube.com/watch?v=5bxDd1PiOMQ).
103+
* [Real-time Sensor Data Logging Using Pocket Science Lab](https://www.youtube.com/watch?v=_A8h6o-UcNo).
104+
* [Generating and Observing Waveforms Using Pocket Science Lab](https://www.youtube.com/watch?v=Ua9_OCR4p8Y).
105105

106106
## Features
107107
| **Feature** | **Description** | **Status** |
@@ -151,28 +151,19 @@ If you built your own hardware, change VendorID and/or ProductID in [Communicati
151151

152152
### By direct cloning
153153

154-
155-
1. Open Android Studio, you will see a **Welcome to Android** window. Under Quick Start, select "check out project from version control".
156-
157-
2. Select git from the drop down menu that appeared.
158-
159-
3. Go to the repository and click clone or download button.
160-
161-
4. From the dropdown that appeared, copy the link.
162-
163-
5. Paste the URL that you copied and press clone.
164-
165-
6. Android studio should now begin building the project with gradle.
166-
167-
7. Once this process is complete and Android Studio opens, check the Console for any build errors.
154+
1. Open Android Studio, you will see a **Welcome to Android** window. Under Quick Start, select "check out project from version control".
155+
2. Select git from the drop down menu that appeared.
156+
3. Go to the repository and click clone or download button.
157+
4. From the dropdown that appeared, copy the link.
158+
5. Paste the URL that you copied and press clone.
159+
6. Android studio should now begin building the project with gradle.
160+
7. Once this process is complete and Android Studio opens, check the Console for any build errors.
168161

169162
- _Note:_ If you receive a Gradle sync error titled, "failed to find ...", you should click on the link below the error message (if available) that says _Install missing platform(s) and sync project_ and allow Android studio to fetch you what is missing.
170163

171-
8. Once all build errors have been resolved, you should be all set to build the app and test it.
172-
173-
9. To Build the app, go to _Build>Make Project_ (or alternatively press the Make Project icon in the toolbar).
174-
175-
10. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to _Run>Run 'app'_ or pressing the Run icon in the toolbar.
164+
8. Once all build errors have been resolved, you should be all set to build the app and test it.
165+
9. To Build the app, go to _Build>Make Project_ (or alternatively press the Make Project icon in the toolbar).
166+
10. If the app was built successfully, you can test it by running it on either a real device or an emulated one by going to _Run>Run 'app'_ or pressing the Run icon in the toolbar.
176167

177168
If you want build apk only, go to Build>Build apk and apk would be build and directory where apk is generated would be prompted by Android Studio.
178169

@@ -199,11 +190,11 @@ To use PSLab device with Android, you simply need an OTG cable, an Android Devic
199190

200191
Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
201192

202-
* Single commit per pull request.
203-
* Reference the issue numbers in the commit message. Follow the pattern ``` Fixes #<issue number> <commit message>```
204-
* Follow uniform design practices. The design language must be consistent throughout the app.
205-
* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
206-
* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
193+
* Single commit per pull request.
194+
* Reference the issue numbers in the commit message. Follow the pattern ``` Fixes #<issue number> <commit message>```
195+
* Follow uniform design practices. The design language must be consistent throughout the app.
196+
* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
197+
* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.
207198

208199
#### How to `git squash`?
209200

@@ -263,9 +254,9 @@ The project is maintained by
263254
- Lorenz Gerber ([@lorenzgerber](https://github.com/lorenzgerber))
264255
- Wei Tat ([@cweitat](https://github.com/cweitat))
265256
- Wai Gie ([@woshikie](https://github.com/woshikie))
266-
- Neel Trivedi ([@neel1998](https://github.com/neel1998))
267257

268258
### Alumni
259+
- Neel Trivedi ([@neel1998](https://github.com/neel1998))
269260
- Akarshan Gandotra ([@akarshan96](https://github.com/akarshan96))
270261
- Asitava Sarkar ([@asitava1998](https://github.com/asitava1998))
271262
- Vivek Singh Bhadauria ([@viveksb007](https://github.com/viveksb007))

0 commit comments

Comments
 (0)