diff --git a/README.md b/README.md new file mode 100644 index 00000000..858801f3 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# OpenTM2 - an open source Windows Translation Memory Server + +OpenTM2 was originally developed for by IBM as a Windows Translation Memory Server. + +## 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 + +Windows 10 or Windows Server 2012 or higher + +### 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 (ToDo) + +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 + + + +## 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. + + + +## Authors (ToDo) + +* **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. + +## License (ToDo?) + +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