Skip to content

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.

@IshaanDesai IshaanDesai requested a review from sanathkeshav May 2, 2025 14:47
@IshaanDesai IshaanDesai added this to the 0.4.0 milestone May 2, 2025
@sanathkeshav sanathkeshav changed the title Rework existing README and add a new one for the tests Rework existing README May 19, 2025
@IshaanDesai IshaanDesai merged commit 48c617d into develop May 21, 2025
7 checks passed
@IshaanDesai IshaanDesai deleted the rework-readmes branch May 21, 2025 13:54
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.

3 participants