Merge pull request #183 from leoherbie/RESKC-223

RESKC-223: adding documentation
kuali · Mar 14, 2015 · fc13465 · fc13465
2 parents 2375881 + e63af1d
commit fc13465
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,28 @@ Kuali Coeus
 ==
 
 Kuali Coeus (KC) for Research Administration is a comprehensive system to manage the complexities of research administration needs from the faculty researcher through grants administration to federal funding agencies. KC is using MIT’s proven COEUS system as its baseline design, updating its technical architecture for vendor independence and integration with other administration systems.
+
+
+Build instructions
+
+The Kuali Coeus application uses maven as it's build tool and can be built with a simple mvn clean install.  Inside
+of Kuali Coeus's maven configuration is a list of dependencies.  Some of these dependencies may not be available in
+a publicly available maven repository.  At the very least you will need to install the following projects into your
+maven repo.  These projects may have more than one submodule.
+
+* Kuali Coeus API
+* Kuali Coeus S2S Gen
+* Kuali Rice
+
+Grm Profile
+
+When building Kuali Coeus you should turn the grm maven profile off.  You can do this by commenting out the activation
+section of the profile or sending the following system parameter grm.off on the command line.  This profile is internal
+to KualiCo.
+
+Populating a Database
+
+All the data needed to run Kuali Coeus is located in the coeus-db module.  They are conveniently divided into jar modules
+to support any automated sql processes you may have.  The coeus-db-sql project contains sequenced sql and java files
+that can build a database from scratch.  See the README file for more information.  The coeus-db-xml contains all
+Kuali Coeus and Rice KEW configuration files.  These contains all the KEW files for a complete KEW configuration.
diff --git a/coeus-impl/pom.xml b/coeus-impl/pom.xml
@@ -689,6 +689,7 @@
     <profiles>
         <profile>
             <id>grm</id>
+            <!-- comment out activation section to turn this profile off permanently-->
             <activation>
                 <property>
                     <name>!grm.off</name>

diff --git a/pom.xml b/pom.xml
@@ -2019,6 +2019,7 @@
     <profiles>
         <profile>
             <id>grm</id>
+            <!-- comment out activation section to turn this profile off permanently-->
             <activation>
                 <property>
                     <name>!grm.off</name>