From b8425f0e313d2d8702bbebb17d1d9746d455e75f Mon Sep 17 00:00:00 2001 From: Remy Blaettler Date: Tue, 15 Jan 2019 16:35:35 +0100 Subject: [PATCH 1/3] Create README.md --- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..860b55b6 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Project Title + +One Paragraph of project description goes here + +## Getting Started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. + +### Prerequisites + +What things you need to install the software and how to install them + +``` +Give examples +``` + +### Installing + +A step by step series of examples that tell you how to get a development env running + +Say what the step will be + +``` +Give the example +``` + +And repeat + +``` +until finished +``` + +End with an example of getting some data out of the system or using it for a little demo + +## Running the tests + +Explain how to run the automated tests for this system + +### Break down into end to end tests + +Explain what these tests test and why + +``` +Give an example +``` + +### And coding style tests + +Explain what these tests test and why + +``` +Give an example +``` + +## Deployment + +Add additional notes about how to deploy this on a live system + +## Built With + +* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used +* [Maven](https://maven.apache.org/) - Dependency Management +* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds + +## Contributing + +Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). + +## Authors + +* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) + +See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details + +## Acknowledgments + +* Hat tip to anyone whose code was used +* Inspiration +* etc From d3d5369ffb3b9b03fdfbd44a61d326e986ea98f9 Mon Sep 17 00:00:00 2001 From: Remy Blaettler Date: Tue, 15 Jan 2019 16:44:35 +0100 Subject: [PATCH 2/3] Inital version with links to the documentation Added links to the documentation pdf and referenced Gerhard. --- README.md | 56 +++++++++++++++---------------------------------------- 1 file changed, 15 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 860b55b6..67674fb3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Project Title +# OpenTM2 - an open source Windows Translation Memory Server -One Paragraph of project description goes here +OpenTM2 was originally developed for by IBM as a Windows Translation Memory Server. ## Getting Started @@ -8,13 +8,17 @@ These instructions will get you a copy of the project up and running on your loc ### Prerequisites -What things you need to install the software and how to install them +Windows 10 or Windows Server 2012 or higher -``` -Give examples -``` +### Documentation +OpenTM2 API for the C++-Kernel +https://github.com/OpenTM2/opentm2-source/blob/master/Doc/Opentm2TechnicalReference.pdf + +REST API Docu +https://jira.translate5.net/secure/attachment/14902/OpenTM2%20REST-API.pdf -### Installing + +### Installing (ToDo) A step by step series of examples that tell you how to get a development env running @@ -32,51 +36,21 @@ until finished End with an example of getting some data out of the system or using it for a little demo -## Running the tests - -Explain how to run the automated tests for this system - -### Break down into end to end tests - -Explain what these tests test and why - -``` -Give an example -``` -### And coding style tests - -Explain what these tests test and why - -``` -Give an example -``` - -## Deployment - -Add additional notes about how to deploy this on a live system - -## Built With - -* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used -* [Maven](https://maven.apache.org/) - Dependency Management -* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds ## Contributing Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. -## Versioning - -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). + -## Authors +## Authors (ToDo) -* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth) +* **Gerhard Queck** - *Initial work* - [PurpleBooth](https://github.com/GerhardQ) See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project. -## License +## License (ToDo?) This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details From 96ddbf2a9614d8b7812e08060bb915bc9adbfadd Mon Sep 17 00:00:00 2001 From: Remy Blaettler Date: Tue, 15 Jan 2019 16:45:04 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 67674fb3..858801f3 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ These instructions will get you a copy of the project up and running on your loc Windows 10 or Windows Server 2012 or higher ### Documentation -OpenTM2 API for the C++-Kernel +OpenTM2 API for the C++-Kernel https://github.com/OpenTM2/opentm2-source/blob/master/Doc/Opentm2TechnicalReference.pdf -REST API Docu +REST API Docu https://jira.translate5.net/secure/attachment/14902/OpenTM2%20REST-API.pdf @@ -46,7 +46,7 @@ Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c6 ## Authors (ToDo) -* **Gerhard Queck** - *Initial work* - [PurpleBooth](https://github.com/GerhardQ) +* **Gerhard Queck** - *Initial work* - [GitHub Profile](https://github.com/GerhardQ) See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.