Skip to content

Commit

Permalink
docs: add screenshots section
Browse files Browse the repository at this point in the history
  • Loading branch information
EdricChan03 committed Mar 5, 2018
1 parent 470bdbe commit a4ac8af
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,23 @@ To get the latest pre-release, go to [Releases](https://github.com/Chan4077/Stud
- Settings (Currently doesn't affect anything)
- Add tooltips to practically every single view (using `TooltipCompat` recently introduced in Design support `v26.0.0`)

## Screenshots

### Login Activity

Login Activity | Login > Forgot password
---|---
[![Login Activity][art-login-activity]][art-login-activity] | [![Login > Forgot password][art-login-forgot-password]][art-login-forgot-password]

### Main Activity

Main Activity | Main Activity > Dialog (Add new task)
---|---
[![Main Activity][art-main-activity]][art-main-activity] | [![Main Activity > Dialog (Add new task)][art-main-activity-dialog-add-task]][art-main-activity-dialog-add-task]
### Settings
Settings > Experimental | Settings > Notifications (Oreo devices) | Settings > Notifications (Pre-Oreo devices)
---|---|---
[![Settings > Experimental][art-settings-experimental]][art-settings-experimental] | [![Settings > Notifications (Oreo devices)][art-settings-notifications-oreo]][art-settings-notifications-oreo] | [![Settings > Notifications (Pre-Oreo devices)][art-settings-notifications-pre-oreo]][art-settings-notifications-pre-oreo]
---
## Building/ Contributing
If you would like to build the source code, follow these steps:
Expand All @@ -31,4 +48,12 @@ If you would like to build the source code, follow these steps:
git clone https://github.com/Chan4077/StudyBuddy.git
```

Otherwise, if you would like to contribute, please go ahead and submit a pull request explaining your changes to the code and making sure that you open an issue beforehand.
Otherwise, if you would like to contribute, please go ahead and submit a pull request explaining your changes to the code and making sure that you open an issue beforehand.

[art-login-activity]: art/screenshots/login_1.png
[art-login-forgot-password]: art/screenshots/login_forgot_password.png
[art-main-activity]: art/screenshots/main_1.png
[art-main-activity-dialog-add-task]: art/screenshots/main_dialog_add_task.png
[art-settings-experimental]: art/screenshots/settings_experimental.png
[art-settings-notifications-oreo]: art/screenshots/settings_notifications_oreo.png
[art-settings-notifications-pre-oreo]: art/screenshots/settings_notifications_pre_oreo.png
Binary file added art/screenshots/main_dialog_add_task.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4ac8af

Please sign in to comment.