Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README #2

Merged
merged 1 commit into from Jun 18, 2019
Merged

Add README #2

merged 1 commit into from Jun 18, 2019

Conversation

nelsonmestevao
Copy link
Contributor

Leave some ideas of what I could explain more and better, please 馃檹

@protodan
Copy link
Collaborator

Hi Nelson!

I would write a paragraph on the beginning on the following lines (feel free to rewrite, did not check the grammar):

## Introduction
Sometimes there are benefits on writing unit tests for your solutions both while training and in competition setups. One of the goals of this repo is to simplify that process.

In order to do so, hereby is provided a class that enables the automatic execution and debugging of your code using test cases provided in text files.

[EXAMPLE]

Maybe you could add a section on Tips (e.g. a shortcuts to run the TextExecutor and set breakpoints).

Additionally, a gif with the process of using this tool (or a description of the series of steps) would be valuable for the rookies (in the [EXAMPLE] part of the introduction).

Anyway, this readme is something that will be improved along the times, so do pls do not feel like it has to be perfect right now.

What do you think?

@nelsonmestevao
Copy link
Contributor Author

Thank you for your feedback. I will take it in account and improve upon it.

I will definitely add the introduction and a gif, as suggested.

@nelsonmestevao nelsonmestevao changed the title WIP: Add README Add README Jun 17, 2019
@nelsonmestevao
Copy link
Contributor Author

@protodan what do you think of this one for starting? I removed the WIP tag from the PR.

@protodan
Copy link
Collaborator

LGTM! feel free to merge it

@nelsonmestevao nelsonmestevao merged commit 31ca1ac into dpum:master Jun 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants