Skip to content

Commit

Permalink
added markdown readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bwolfe committed Aug 14, 2012
1 parent 85182d5 commit 4110c3d
Show file tree
Hide file tree
Showing 3 changed files with 192 additions and 0 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@

OpenMRS is an patient-based medical record system focusing on providing care

Read more at http://openmrs.org/about

Find documentation on our wiki: http://wiki.openmrs.org

The project tree is set up as follows:

<table>
<tr>
<td>.settings</td>
<td>Eclipse specific settings. Useful for character encoding and formatting (for devs using eclipse anyway)</td>
</tr>
<tr>
<td>api/</td>
<td>java and resource files for building the java api jar file.</td>
<td>A standalone maven module</td>
</tr>
<tr>
<td>release-test</td>
<td>Cucumber/selenium integration tests. Run daily against a running webapp. See https://wiki.openmrs.org/display/docs/Testing+Releases</td>
</tr>
<tr>
<td>test</td>
<td>TBD</td>
</tr>
<tr>
<td>tools</td>
<td>Meta code used during compiling and testing. Does not go into any released binary (like doclets)</td>
</tr>
<tr>
<td>web/</td>
<td>java and resource files that are used in the webapp/war file.</td>
<td>A standalone maven module</td>
</tr>
<tr>
<td>webapp/</td>
<td>jsp files used in building the war file.</td>
<td>A standalone maven module</td>
</tr>
<tr>
<td>build.properties</td>
<td>(deprecated) default properties used by the deprecated ANT build.xml file</td>
</tr>
<tr>
<td>build.xml</td>
<td>(deprecated)ANT build file containing convenience methods into the maven build</td>
</tr>
<tr>
<td>license.txt</td>
<td>The OpenMRS license</td>
</tr>
<tr>
<td>liquibase.build.xml</td>
<td>ANT build file containing convenience methods to run liquibase actions</td>
</tr>
<tr>
<td>openmrs-checkstyle.properties</td>
<td>properties for the checkstyle library</td>
</tr>
<tr>
<td>pom.xml</td>
<td>The main maven file used to build and package OpenMRS</td>
</tr>
</table>
18 changes: 18 additions & 0 deletions README.md~
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
OpenMRS

This is the root folder.
The project tree is set up as follows:

api/ java and resource files for building the java api jar file. A standalone maven module
metadata/ configuration files, sql files and other stuff
web/ java and resource files that are used in the webapp/war file. A standalone maven module
webapp/ jsp files used in building the war file. A standalone maven module
.classpath classpath settings (generated by and used by eclipse)
.project project settings (generated by and used by eclipse)
build.properties default properties used by the ANT build.xml file
build.xml ANT build file containing convenience methods into the maven build
license.txt the OpenMRS license
liquibase.build.xml ANT build file containing convenience methods to run liquibase actions
openmrs-checkstyle.properties checkstyle jar properties
pom.xml The main maven file
readme.txt this readme file
108 changes: 108 additions & 0 deletions properties.xml~
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="properties">

<!-- Webapp properties -->
<property name="webapp.name" value="openmrs" />
<property name="webapp.version" value="${openmrs.version}" />
<property name="webapp.display.name" value="OpenMRS" />
<property name="webapp.description" value="An Open-Source EMR System" />

<!-- Properties for running unit tests and webapp [un]deploy with tomcat -->
<property name="tomcat.home" value="${env.CATALINA_HOME}"/>
<property name="catalina.home" value="${env.CATALINA_HOME}"/>
<property name="tomcat.server" value="localhost" />
<property name="tomcat.port" value="8080" />
<property name="tomcat.manager.url" value="http://${tomcat.server}:${tomcat.port}/manager" />
<property name="tomcat.username" value="test" />
<property name="tomcat.password" value="test" />

<!-- Documentation settings -->
<property name="doc.title" value="${ant.project.name} API" />
<property name="doc.bottom"
value="&lt;em&gt;&lt;small&gt;Generated ${timestamp}. NOTE - these libraries are in active development and subject to change&lt;/small&gt;&lt;/em&gt;"/>
<property name="doc.header"
value="&lt;a href=&quot;http://www.openmrs.org&quot; target=_top&gt;&lt;img src=&quot;/doc/openmrs-logo-small.gif&quot; border=0/&gt;&lt;/a&gt;"/>
<property name="doc.footer"
value="&lt;a href=&quot;http://www.openmrs.org&quot; target=_top&gt;${ant.project.name}&lt;/a&gt;"/>

<!-- =================================================================== -->
<!-- Classpaths -->
<!-- =================================================================== -->

<!-- Hibernate -->
<path id="hibernate.classpath">
<fileset dir="${cglib.dir}" includes="*.jar" />
<fileset dir="${commons-beanutils.dir}" includes="*.jar" />
<fileset dir="${commons-collections.dir}" includes="*.jar" />
<fileset dir="${commons-lang.dir}" includes="*.jar" />
<fileset dir="${database.dir}" includes="*.jar" />
<fileset dir="${dom4j.dir}" includes="*.jar" />
<fileset dir="${hibernate.dir}" includes="*.jar" />
<fileset dir="${jta.dir}" includes="*.jar" />
<pathelement location="${build.dir}/api" />
</path>

<!-- API -->
<path id="api.compile.classpath">
<!--<fileset dir="${activemq.dir}" includes="*.jar" />-->
<fileset dir="${antlr.dir}" includes="*.jar" />
<fileset dir="${cglib.dir}" includes="*.jar" />
<fileset dir="${commons-io.dir}" includes="*.jar" />
<fileset dir="${commons-lang.dir}" includes="*.jar"/>
<fileset dir="${commons-beanutils.dir}" includes="*.jar" />
<fileset dir="${commons-collections.dir}" includes="*.jar" />
<fileset dir="${dom4j.dir}" includes="*.jar" />
<fileset dir="${hibernate.dir}" includes="*.jar" />
<fileset dir="${hl7api.dir}" includes="*.jar" />
<fileset dir="${jfreechart.dir}" includes="*.jar" />
<fileset dir="${junit.dir}" includes="*.jar" />
<fileset dir="${log4j.dir}" includes="*.jar" />
<fileset dir="${mail.dir}" includes="*.jar" />
<fileset dir="${slf4j.dir}" includes="*.jar" />
<fileset dir="${simple.dir}" includes="*.jar" />
<fileset dir="${spring.dir}" includes="*.jar" />
<fileset dir="${stax.dir}" includes="*.jar" />
<fileset dir="${velocity.dir}" includes="*.jar" />
<fileset dir="${xerces.dir}" includes="*.jar" />
<fileset dir="${xstream.dir}" includes="*.jar" />
<fileset dir="${liquibase.dir}" includes="*.jar"/>
<fileset dir="${reflectionutil.dir}" includes="*.jar"/>
</path>
<path id="api.test.classpath">
<path refid="api.compile.classpath"/>
<fileset dir="${dist.dir}" includes="*.jar" />
<fileset dir="${junit.dir}" includes="*.jar" />
<fileset dir="${test.dir}/api" includes="**/*.java" />
<fileset dir="${tomcat.dir}" includes="*.jar" />
<fileset dir="${benerator.dir}" includes="*.jar" />
</path>

<!-- Web -->
<path id="web.compile.classpath">
<pathelement location="${dist.dir}/openmrs-api-${openmrs.version}.jar" />
<fileset dir="${commons-io.dir}" includes="*.jar" />
<fileset dir="${commons-lang.dir}" includes="*.jar" />
<fileset dir="${commons-beanutils.dir}" includes="*.jar" />
<fileset dir="${commons-collections.dir}" includes="*.jar" />
<fileset dir="${commons-fileupload.dir}" includes="*.jar" />
<fileset dir="${dwr.dir}" includes="*.jar" />
<fileset dir="${hibernate.dir}" includes="*.jar" />
<fileset dir="${hl7api.dir}" includes="*.jar" />
<fileset dir="${jfreechart.dir}" includes="*.jar" />
<fileset dir="${jstl.dir}" includes="*.jar" />
<fileset dir="${log4j.dir}" includes="*.jar" />
<fileset dir="${slf4j.dir}" includes="*.jar" />
<fileset dir="${simple.dir}" includes="*.jar" />
<fileset dir="${spring.dir}" includes="*.jar" />
<fileset dir="${stax.dir}" includes="*.jar" />
<fileset dir="${taglibs.dir}" includes="*.jar" />
<fileset dir="${tomcat.dir}" includes="*.jar" />
<fileset dir="${velocity.dir}" includes="*.jar" />
<fileset dir="${xerces.dir}" includes="*.jar" />
<fileset dir="${xstream.dir}" includes="*.jar" />
<fileset dir="${liquibase.dir}" includes="*.jar"/>
<fileset dir="${json.dir}" includes="*.jar"/>
<fileset dir="${reflectionutil.dir}" includes="*.jar"/>
</path>

</project>

0 comments on commit 4110c3d

Please sign in to comment.