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.

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 Updated #1818

Merged
merged 3 commits into from
Nov 23, 2024
Merged

Readme Updated #1818

merged 3 commits into from
Nov 23, 2024

Conversation

revanthkumarJ
Copy link
Contributor

Issue Fix

Fixes #{Issue Number}
Jira Task: Task_Number


Description

Summary of Changes Made:

  • Updated README:

    • Added navigation links from the wiki for better readability.
    • Replaced old app screenshots with updated ones.
  • Created Platform-Specific Markdown Files:

    • Windows.md: Contains Mifos Pay Windows app screenshots.
    • Android.md: Contains Mifos Pay Android app screenshots.
    • Linux.md: Contains Mifos Pay Linux app screenshots.
  • Added Navigation Table:

    • The home README now includes a table linking to the platform-specific pages, ensuring easy navigation.

Checklist

Please ensure the following before submitting your pull request:

  • Apply the AndroidStyle.xml style template to your code in Android Studio.
  • Run the unit tests with ./gradlew check to make sure you didn't break anything.
  • If you have multiple commits, please combine them into one commit by squashing them.

Copy link
Collaborator

@niyajali niyajali left a comment

Choose a reason for hiding this comment

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

Looks good me, but it's gonna increase project size
for example 90 images and per images 150 kb so size would be increased by 13.5 MB which is huge,

instead of you edit your md files in this opened pr and upload imaged directly and use those link in table.

@niyajali
Copy link
Collaborator

niyajali commented Nov 23, 2024

@revanthkumarJ For example, see in Android.md file i've just dragged an image and it's uploaded and provided a link and used that link in table,
you can do like this,
just drop the image that you want to upload from file and it would be easy since you've numbered the file see which image you need in the row and upload it and use the link instead of direct folder image reference.

@revanthkumarJ
Copy link
Contributor Author

ok i will do it

@revanthkumarJ
Copy link
Contributor Author

@niyajali check it once , i have drag and dropped images and used them in tables and deleted the previously added images folder

@@ -2,15 +2,18 @@

# Mobile Wallet

Mobile Wallet is an Android-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows
Mobile Wallet is an Kotlin Multiplatform (KMP)-based framework for mobile wallets based on top of <a href='https://github.com/openMF/mobile-wallet/wiki/Fineract-backend'>Fineract</a>. The app follows
Copy link
Collaborator

Choose a reason for hiding this comment

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

update this line - KMP Application, not a framework

- Development and enhancements related to Kotlin Multiplatform.
- Logical changes or improvements in existing Jetpack Compose-based features.

We appreciate your contributions and look forward to collaborating with you!

| Development | Chat |
|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| ![Mobile-Wallet CI[Master/Dev]](https://github.com/openMF/mobile-wallet/workflows/Mobile-Wallet%20CI%5BMaster/Dev%5D/badge.svg?branch=dev) | [![Join the chat at https://mifos.slack.com/](https://img.shields.io/badge/Join%20Our%20Community-Slack-blue)](https://mifos.slack.com/) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

update this badge with updated workflow file this is old and we don't have this workflow, and can you upload some badges like kotlin, kmp, etc to top of the file.


* **master**
The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.
To know more about branch policies, click [here](https://github.com/openMF/mobile-wallet/wiki/Branch-Policy).

### Demo credentials
Copy link
Collaborator

Choose a reason for hiding this comment

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

And move this block below to Run the project section

@@ -58,22 +61,24 @@ that can be used as a dependency in any other wallet based project. It is develo
✔️: Successfully compiled
❌: Not functioning, requires further attention

## Notice
⚠️ **Notice:**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove this notice, since we've migrated whole app to KMP & CMP


Replace **`new-branch-name`** with the name of the branch you created earlier.
Once you make changes in your local repository, you need to commit them to your GitHub repository.
Don't know how to commit? Click [here](https://github.com/openMF/mobile-wallet/wiki/Committing-Your-Changes) to learn more.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Use formal words and sentences for the good impression

@therajanmaurya therajanmaurya merged commit 0fa31c0 into openMF:dev Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants