Skip to content

Rework existing README and add a new one for the tests #54

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

IshaanDesai
Copy link
Collaborator

This PR reworks the existing README by streamlining it and removing parts which are not directly relevant to FANS. It also adds a README for the test/ folder.

@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label May 2, 2025
@IshaanDesai IshaanDesai self-assigned this May 2, 2025
@IshaanDesai
Copy link
Collaborator Author

We should rename the folder test/ to tests/ to be consistent with what the naming convention in most other repositories is. But let us do that in a separate PR to not mess up the change history here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants