Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
added project info and changed some formatting
  • Loading branch information
phlpl authored Oct 24, 2023
1 parent 7f411fa commit ec3ccaa
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# SCTP-2

This is a multi-mode maven project.
## Project Objectives

#### Requirements
* The Social Cash Transfer Programme aims to reduce poverty and hunger, and increase school enrolment.
* It is designed to provide bi-monthly unconditional cash transfers to more than 300,000 households categorised as poor, severely impoverished and labour constrained.
* The Management Information System aims to support new and existing operational needs of the programme.

## Environment Requirements

- **Runtime Environment**: [Java 16](https://adoptopenjdk.net/?variant=openjdk16&jvmVariant=hotspot)
- **Database**: [MySQL 8](https://dev.mysql.com/downloads/mysql/)

## Project sub-modules
## Project Sub-modules

This is a multi-mode maven project.

1. [sctp-core](/sctp-core)

Expand Down Expand Up @@ -78,7 +84,7 @@ For more Spring Boot configuration reference, see:
- [Spring Boot Reference Documentation](https://docs.spring.io/spring-boot/docs/2.4.5/reference/html/index.html)
- [Common Application properties](https://docs.spring.io/spring-boot/docs/2.4.5/reference/html/appendix-application-properties.html#common-application-properties)
# License
## License
```text
Copyright (C) 2021 CGA Technologies, a trading name of Charlie Goldsmith Associates Ltd
Expand All @@ -99,4 +105,4 @@ Redistribution and use in source and binary forms, with or without modification,
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For more information please see http://opensource.org/licenses/BSD-3-Clause
```
```

0 comments on commit ec3ccaa

Please sign in to comment.