Improve REMReM introduction description

[m-linner-ericsson]

Applicable Issues

None

Description of the Change

Add an introduction description of what REMReM does. The introduction also spells out what REMReM stands for.

Other things fixed:

• Fix spelling of REMReM
• Remove reference to REMReM shared (not used)
• Removed non needed copyright headers

Alternate Designs

Couldn't find any other better place to put this information.

Benefits

New readers can understand what REMReM does. The current description did not give that introduction.

Possible Drawbacks

None that I can think of

Sign-off

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Signed-off-by: Mattias Linnér mattias.linner@ericsson.com

[m-linner-ericsson]

Also one more thing, in the architecture diagram it is pointing to shared library, has that been modified ? If not the picture has to be modified to reflect the current behavior.

Thanks @SantoshNC68! Fixed in 9f0e2d9

[m-linner-ericsson]

@SantoshNC68 In https://github.com/eiffel-community/eiffel-remrem-publish/blob/master/pom.xml#L13 it looks like publish uses both semantics and shared. Same with https://github.com/eiffel-community/eiffel-remrem-generate/blob/master/pom.xml#L14. Is the picture then correct?

[SantoshNC68]

@SantoshNC68 In https://github.com/eiffel-community/eiffel-remrem-publish/blob/master/pom.xml#L13 it looks like publish uses both semantics and shared. Same with https://github.com/eiffel-community/eiffel-remrem-generate/blob/master/pom.xml#L14. Is the picture then correct?

The eiffel-remrem-shared earlier used to have the code for protocol interfaces that needed to be extended in eiffel-remrem-semantics, but that has changed and now any protocol that should define its own definition of generate, version, etc needs to extend eiffel-remrem-protocol-interface.

There are left over code like VersionService which is used to identify the semantics/any other versions using endpoints using the VersionService class present in the shared library. But the picture will still remain the same as I suggested that the semantics/other protocols should have a dotted connection to eiffel-remrem-protocol-interface.

[m-linner-ericsson]

@SantoshNC68 I have now in 5e05d85 updated the image. I guess that the POMs for generate and publish need updates?

[e-backmark-ericsson]

@SantoshNC68 , will you write issues on generate and publish to update their POMs accordingly? We shouldn't remove the shared repo until all references to it are gone.