Update README.md

clarifying the "About" and "Instructions to download gradle wrapper" sections and fixing typos
This commit is contained in:
Vishwas Babu A J
2019-02-22 14:17:56 -08:00
committed by GitHub
parent fa41f0cc7a
commit 8b14bb88a7
+9 -10
View File
@@ -1,7 +1,6 @@
Apache Fineract: A Platform for Microfinance [![Build Status](https://travis-ci.org/apache/fineract.svg?branch=develop)](https://travis-ci.org/apache/fineract) Apache Fineract: A Platform for Microfinance [![Build Status](https://travis-ci.org/apache/fineract.svg?branch=develop)](https://travis-ci.org/apache/fineract)
============ ============
Fineract is a mature platform with open APIs that provides a reliable, robust, and affordable core banking solution for financial institutions offering services to the world’s 2 billion underbanked and unbanked.
The next evolution of Apache Fineract focuses on being faster, lighter and cheaper to change (than the existing Mifos) so that it is more responsive to the needs of Microfinance Institutions and Integrators.
Requirements Requirements
============ ============
@@ -11,13 +10,13 @@ Requirements
Instructions to download gradle wrapper Instructions to download gradle wrapper
============ ============
By running following command, it will download the gradle wrapper from Fineract git repository and put it under fineract-provider/gradle/wrapper If the file fineract-provider/gradle/wrapper/gradle-wrapper.jar doesn't already exist in your copy of the Fineract codebase, the same needs to be downloaded using the commands below
wget --no-check-certificate -P fineract-provider/gradle/wrapper https://github.com/apache/incubator-fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar wget --no-check-certificate -P fineract-provider/gradle/wrapper https://github.com/apache/fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar
(or) (or)
curl --insecure -L https://github.com/apache/incubator-fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar > fineract-provider/gradle/wrapper/gradle-wrapper.jar curl --insecure -L https://github.com/apache/fineract/raw/develop/fineract-provider/gradle/wrapper/gradle-wrapper.jar > fineract-provider/gradle/wrapper/gradle-wrapper.jar
Instructions to run Apache RAT (Release Audit Tool) Instructions to run Apache RAT (Release Audit Tool)
============ ============
@@ -28,7 +27,7 @@ Instructions to run Apache RAT (Release Audit Tool)
Instructions to build a war file Instructions to build a war file
============ ============
1. Extract the archive file to your local directory. 1. Extract the archive file to your local directory.
2. Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above. 2. Ensure gradle-wrapper.jar version 2.10 is present in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
3. Run `./gradlew clean war` or `./gradlew build` to build deployable war file which will be created at build/libs directory. 3. Run `./gradlew clean war` or `./gradlew build` to build deployable war file which will be created at build/libs directory.
@@ -36,8 +35,8 @@ Instructions to execute Integration tests
============ ============
1. Login to mysql DB using `mysql -u root -p mysql` 1. Login to mysql DB using `mysql -u root -p mysql`
> Note that if this is the first time to access MySQL DB, then you may need to reset your password. > Note that if this is the first time to access MySQL DB, then you may need to reset your password.
2. Create the mifosplatform-tenants database using `CREATE DATABASE mifosplatform_tenants`. 2. Create the mifosplatform-tenants database using `CREATE DATABASE mifosplatform-tenants`.
3. Create the default tenant database using `CREATE DATABASE mifostenant_default`. 3. Create the default tenant database using `CREATE DATABASE mifostenant-default`.
4. Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above. 4. Download gradle-wrapper.jar version 2.10 and place it in the fineract-provider/gradle/wrapper folder. See 'Instructions to download gradle wrapper' above.
5. Run the following commands: 5. Run the following commands:
1. `./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants` 1. `./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants`
@@ -48,9 +47,9 @@ Instructions to execute Integration tests
Version Version
============ ============
The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/incubator-fineract/tree/develop "Latest Release"). The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/fineract/tree/develop "Latest Release").
The progress of this project can be viewed here: [View change log](https://github.com/apache/incubator-fineract/blob/develop/CHANGELOG.md "Latest release change log") The progress of this project can be viewed here: [View change log](https://github.com/apache/fineract/blob/develop/CHANGELOG.md "Latest release change log")
License License
============ ============