Pre Release Clean Up

Author: dschwartz-ftadvisory

BUILDANDTEST.md

@@ -1,15 +1,17 @@
 # _Build and testing instructions_
 
+## Setup
+
+1. Clone the repo to your local directory
+2. Change to the installation directory
+
 ## To build the generator and run the JUnit tests
 
 ```sh
 mvn clean install
 ```
 
-There are two types of JUnit tests to confirm that generated code matches expectations.
-
-1. In memory string comparisons of generated Python to expected results.
-2. Generated Python written to the file system (see the target directory) compared to expected results read from the file system (see the directory test/compare_generated_syntax/expected).
+The JUnit tests conduct string comparisons of Python generated from Rune samples expected results.
 
 All tests should pass.
 

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 This document describes the contribution process and governance policies of the FINOS {project name} project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy]( https://community.finos.org/governance-docs/IP-policy.pdf), [Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct), [Collaborative Principles](https://community.finos.org/docs/governance/collaborative-principles/), and [Meeting Procedures](https://community.finos.org/docs/governance/meeting-procedures/).
 
 ## Contribution Process
-x
+
 Before making a contribution, please take the following steps:
 1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
 2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.

README.md

@@ -9,39 +9,27 @@ The Python package requires Python version 3.11+.
 ## Repository Organization
 
 - `README.md` - this file, for documentation purposes
+- `BUILDANDTEST.md` - instructions on building and testing the repo
+- `RELEASE.md` - information about the current release
 - `src/main`  - Java/Xtend code to generate Python from Rune
 - `src/test`  - Java/Xtend code to run JUnit tests on the code generation process
 - `build` - configuration scripts to setup and tear down the Python unit testing environment
 - `build/build_cdm.sh` - used to create a Python package from code generated using CDM Rune definitions
 - `test` - Python unit tests and scripts to run the tests
 
-## Prerequisites
-
-[Eclipse 2021 (JSEE) + xtend support Eclipse IDE for Java and DSL Developers](https://www.eclipse.org/downloads/packages/release/2021-12/r/eclipse-ide-java-and-dsl-developers)
-
-[Git](https://git-scm.com/)
+## Installation Steps
+Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
 
-[Maven](http://maven.apache.org/)
+A quick overview follows:
 
-## Installation Steps
-1. Create a directory structure hereafter referred to as [CODEGEN]
-```
-mkdir -p [CODEGEN]
-```
-2. Fork and clone the generator 
-Fork a copy from `https://github.com/REGnosys/rune-python-generator` ([MYREPO])
-```
-cd [CODEGEN]
-git clone https://github.com/[MYREPO]/rune-python-generator.git
-```
-3. Build and test using Maven
+1. Make a local copy of this repo
+2. Build and test using Maven
 ```
 cd rune-python-generator
 mvn -s clean install
 ```
 All the tests should pass.
 
-More build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
 
 ## Contributing
 For any questions, bugs or feature requests please open an [issue](https://github.com/regnosys/rune-python-generator/issues)
@@ -61,14 +49,14 @@ Use this script to generated the Python version of CDM
 ```sh
 build/build_cdm.sh
 ```
-The script will use the CDM from the master branch of the [FINOS Repo](https://github.com/finos/common-domain-model) and generate a wheel in the project directory `target/python-cdm`
+The script will use the CDM from the branch specified in the file (E.G. master) of the [FINOS Repo](https://github.com/finos/common-domain-model) and generate a wheel in the project directory `target/python-cdm`
 
 To use a different version of CDM, update CDM_VERSION in the script.
 
 ## Contributors
-- [CloudRisk](https://www.cloudrisk.uk)
-- [FT Advisory LLC](https://www.ftadvisory.co)
-- [TradeHeader SL](https://www.tradeheader.com)
+- [CLOUDRISK Limited](https://www.cloudrisk.uk), email: [email protected]
+- [FT Advisory LLC](https://www.ftadvisory.co), email: [email protected]
+- [TradeHeader SL](https://www.tradeheader.com), email: [email protected]
 
 ## Governance
 

build/get_cdm.sh

@@ -19,8 +19,8 @@ rm -rf common-domain-model
 mkdir common-domain-model
 cd common-domain-model
 echo "***** pull CDM rosetta definitions"
-CDM_VERSION="5.22.1"
-# CDM_VERSION="master"
+# CDM_VERSION="5.22.1"
+CDM_VERSION="master"
 git init
 git config core.sparseCheckout true
 echo "rosetta-source/src/main/rosetta" >> .git/info/sparse-checkout