Add readme detailing project layout and commands

This commit is contained in:
Michael Suzuki
2016-06-03 15:05:52 +01:00
parent 3d4b4a839c
commit 5c96520bdc

View File

@@ -0,0 +1,32 @@
# Alfresco Solr Application
TODO Add project description.
## How to build
Build:
```
mvn clean install
```
## How to test
```
mvn test
or
mvn test -Dtest={testname}
```
### Project Layout
```
.
├── /README.md # Readme file.
├── /pom.xml # Project configuration and meta data.
├── /src # Project source code folder.
| ├── /main # Main application folder.
| | ├── /java # Application code.
| | ├── /resources # Main application resource.
| | | ├── /solr # solr resource.
| | ├── /webapp # Web application code.
| ├── /test/ # Test folder.
| | ├── /java # Java test class folder.
| | ├── /resources # Test resource directory.
| | | ├── /test-files # solr test data directory and test solr location.
```