Adding DISCLAIMER and modifying README.md on Main Repo

2016-06-29 14:14:17 +05:30
parent 8ce9edc1a1
commit 7d8e9f57cc
2 changed files with 23 additions and 63 deletions
@@ -0,0 +1 @@
+Apache Fineract is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
@@ -1,72 +1,31 @@
 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

-Build Status
+Requirements
+============
+. Java >= 1.8 (Oracle JVMS have been tested)
+. gradle-wrapper.jar version 2.10
+. MySQL 5.5
+
+Instructions to build war file
 ============

-Travis
+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' to build deployable war file which will be created at fineract-provider/build/libs directory

-[![Build
-Status](https://travis-ci.org/openMF/mifosx.png?branch=master)](https://travis-ci.org/openMF/mifosx)
-
-Cloudbees Jenkins
-
-[![Build
-Status](https://openmf.ci.cloudbees.com/job/MIFOSX%20INTEGRATION%20TEST/badge/icon)](https://openmf.ci.cloudbees.com/job/MIFOSX%20INTEGRATION%20TEST/)
-
-<a target="_blank" href="https://openmf.ci.cloudbees.com/job/MIFOSX%20INTEGRATION%20TEST/"  title="Jenkins@CloudBees">Jenkins@CloudBees Unit + Integration Tests</a>
+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'


-Version
-==========
-
-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 <a target="_blank" href="https://demo.openmf.org/api-docs/apiLive.htm" title="API Documentation"> here
-</a>
-
-Latest stable release can always been viewed on master branch: <a target="_blank" href="https://github.com/openMF/mifosx/tree/master" title="Latest Release">Latest Release on Master</a>, <a target="_blank" href="https://github.com/openMF/mifosx/blob/master/CHANGELOG.md" title="Latest release change log">View change log</a>
-
-License
-=============
-
-This project is licensed under the open source MPL V2. See https://github.com/openMF/mifosx/blob/master/LICENSE.md
-
-Fineract Platform API
-=====================
-
-<a target="_blank" href="https://demo.openmf.org/api-docs/apiLive.htm" title="fineract platform api">API Documentation (Demo Server)</a>
-
-
-Online Demos
-=============================
-
-* <a target="_blank" href="https://demo.openmf.org" title="Reference Client App">Community App</a>
-* ~~<a target="_blank" href="https://demo.openmf.org/old/" title="Community App">Reference Client App (Deprecated)</a>~~
-
-Developers
-==========
-see https://mifosforge.jira.com/wiki/display/MIFOSX/MifosX+Technical - Developers Wiki Page
-
-see https://mifosforge.jira.com/wiki/display/MIFOSX/Getting+started+-+Contributing+to+MifosX  - Getting Started.
-
-see https://mifosforge.jira.com/wiki/display/MIFOSX/The+Basic+Design - Overview of Platform Implementation
-
-see https://github.com/openMF/mifosx/wiki/Screen-Based-Reporting for info around reporting
-
-see https://github.com/openMF/mifosx/wiki/Git-Usuage for info around using git
-
-see https://www.ohloh.net/p/mifosx for activity overview and basic code analysis.
-
-Roadmap
-==============
-
-<a target="_blank" href="http://goo.gl/IXS9Q" title="Community Roadmap (High Level)">Community Roadmap (High Level)</a>
-
-<a target="_blank" href="https://mifosforge.jira.com/browse/MIFOSX#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmap-panel" 
-   title="Project Release Roadmap on JIRA (Detailed View)">Project Release Roadmap on JIRA (Detailed View)</a>
-
-Video Demonstration
-===============
-
-Demonstration of first Prototype of this platform with browser App (April 2012) - http://www.youtube.com/watch?v=zN5Dn1Lc_js
+More details of the project can be found at https://cwiki.apache.org/confluence/display/FINERACT
				`@@ -0,0 +1 @@`
				Apache Fineract is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.