diff --git a/README.rst b/README.rst index 4a0322f..8731249 100644 --- a/README.rst +++ b/README.rst @@ -27,28 +27,3 @@ while searching for object in a given room is left to separate tools. The package is designed as support tool for Assurance of Simulation Models, see DNV-RP-0513. The package is currently under development. More instructions and documentation will be added. - -Getting Started -=============== -The project is under construction. Please consult the module documentation for more information. -TODO: Guide users through getting the code up and running on their own system -and provide a step-by-step explanation how to instantiate a component model. - -1. Installation process -2. Software dependencies -3. Latest releases -4. API references -5. The cases specification format, see : - -Build and Test --------------- -TODO: Describe and show how to build your code and run the tests. - -Contribute ----------- -TODO: Explain how other users and developers can contribute to make your code better. - -If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files: -- [ASP.NET Core](https://github.com/aspnet/Home) -- [Visual Studio Code](https://github.com/Microsoft/vscode) -- [Chakra Core](https://github.com/Microsoft/ChakraCore) \ No newline at end of file