fineract-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nazeer1100...@apache.org
Subject [1/2] incubator-fineract git commit: Update the README File
Date Tue, 13 Dec 2016 13:47:22 GMT
Repository: incubator-fineract
Updated Branches:
  refs/heads/develop 98a865087 -> 5e897a90a


Update the README File

* Reformatted requirements
* Reworded instructions to build war file and execute tests
* Added Version, License, API, Online Demos, Developers, Roadmap, and Demo sections
* Updated SQL Commands by capitalizing CREATE DATABASE to emphasize it as a command


Project: http://git-wip-us.apache.org/repos/asf/incubator-fineract/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-fineract/commit/f88b1cb5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-fineract/tree/f88b1cb5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-fineract/diff/f88b1cb5

Branch: refs/heads/develop
Commit: f88b1cb5563c36923d95b74b90a6efd19844a03d
Parents: cd75af2
Author: Justin Du <justin.d128@gmail.com>
Authored: Mon Dec 5 10:38:03 2016 -0600
Committer: Justin Du <justin.d128@gmail.com>
Committed: Mon Dec 5 21:04:25 2016 -0600

----------------------------------------------------------------------
 README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 53 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-fineract/blob/f88b1cb5/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index e6d2e02..607af9f 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,69 @@
 Apache Fineract: A Platform for Microfinance
 ============
 
-The next evolution of fineract focussing on being faster, lighter and cheaper to change (than
existing mifos) so that it is more responsive to the needs of MFI’s and Integrators
+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
 ============
-. Java >= 1.8 (Oracle JVMS have been tested)
-. gradle-wrapper.jar version 2.10
-. MySQL 5.5
+* Java >= 1.8 (Oracle JVMS have been tested)
+* gradle-wrapper.jar version 2.10
+* MySQL 5.5
 
 Instructions to build war file
 ============
 
-1. Extract the archive file to your local directory
-2. Download gradle-wrapper.jar version 2.10 and place it in fineract-provider/gradle/wrapper
folder
-3. Change current working directory to fineract-provider
-4. Run './gradlew clean war' or './gradlew build' to build deployable war file which will
be created at fineract-provider/build/libs 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.
+3. Change the current working directory to fineract-provider.
+4. Run `./gradlew clean war` or `./gradlew build` to build deployable war file which will
be created at fineract-provider/build/libs directory.
 
 
 Instructions to execute Integration tests
 ============
-1. Login to mysql DB using 'mysql -u root -pmysql'
-2. Create mifosplatform-tenants database using create database `mifosplatform-tenants`;
-3. Create default tenant database using create database `mifostenant-default`;
-4. With fineract-provider as current working directory run below commands
-4.a. ./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants
-4.b. ./gradlew migrateTenantDB -PdbName=mifostenant-default
-5. Run './gradlew clean integrationTest'
+1. Login to mysql DB using `mysql -u root -pmysql`
+2. Create the mifosplatform-tenants database using `CREATE DATABASE mifosplatform-tenants`.
+3. Create the default tenant database using `CREATE DATABASE mifostenant-default`.
+4. With fineract-provider as current working directory run the following commands:
+	1. `./gradlew migrateTenantListDB -PdbName=mifosplatform-tenants`
+	2. `./gradlew migrateTenantDB -PdbName=mifostenant-default`
+5. Run `./gradlew clean integrationTest`
 
+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"), [View change log](https://github.com/apache/incubator-fineract/blob/develop/CHANGELOG.md
"Latest release change log")
+
+License
+============
+
+This project is licensed under Apache License Version 2.0. See <https://github.com/apache/incubator-fineract/blob/develop/LICENSE.md>.
+
+Apache Fineract Platform API
+============
+
+The API for the Fineract-platform (project named 'Apache Fineract') is documented in the
API-docs under <b>Full API Matrix</b> and can be viewed [here](https://demo.openmf.org/api-docs/apiLive.htm
"API Documentation").
+
+Online Demos
+============
+
+* [Community App](https://demo.openmf.org "Reference Client App")
 
-More details of the project can be found at https://cwiki.apache.org/confluence/display/FINERACT
\ No newline at end of file
+Developers
+============
+Please see <https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone>
for the developers wiki page.
+
+Please see <https://cwiki.apache.org/confluence/display/FINERACT/How-to+articles> for
technical details to get started.
+
+Roadmap
+============
+
+[Project Release Roadmap on JIRA (Detailed View)](https://issues.apache.org/jira/browse/FINERACT-268?jql=project%20%3D%20FINERACT
"Project Release Roadmap on JIRA (Detailed View)")
+
+Video Demonstration
+============
+
+Apache Fineract / Mifos X Demo (November 2016) - <https://www.youtube.com/watch?v=h61g9TptMBo>
+
+More Information
+============
+More details of the project can be found at <https://cwiki.apache.org/confluence/display/FINERACT>.
\ No newline at end of file


Mime
View raw message