Skip to content

Commit

Permalink
Remove TODO text from README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jorgelmh committed Jul 1, 2024
1 parent 8e61d30 commit a0ea4d1
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit a0ea4d1

Please sign in to comment.