Skip to content

feat: add READMEs to main directories - #714

Merged
fmontesi merged 5 commits into
mainfrom
fmontesi/readmes
Jul 17, 2026
Merged

feat: add READMEs to main directories#714
fmontesi merged 5 commits into
mainfrom
fmontesi/readmes

Conversation

@fmontesi

Copy link
Copy Markdown
Collaborator

This PR adds README files to some of the main source code directories, covering explanations on principles and vision for CSLib that I've found myself repeating often in private and public conversations.

@ctchou ctchou left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the top-level ORGANISATION.md should reference these files.

Comment thread Cslib/Foundations/README.md
Comment thread Cslib/Algorithms/README.md
@fmontesi

Copy link
Copy Markdown
Collaborator Author

All done, @ctchou, let me know how it looks.

@fmontesi
fmontesi requested a review from ctchou July 16, 2026 17:16

@ctchou ctchou left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@fmontesi
fmontesi added this pull request to the merge queue Jul 17, 2026
Merged via the queue into main with commit 9d42aaa Jul 17, 2026
2 checks passed
fmontesi added a commit that referenced this pull request Jul 22, 2026
This PR adds README files to some of the main source code directories,
covering explanations on principles and vision for CSLib that I've found
myself repeating often in private and public conversations.

---------

Co-authored-by: Fabrizio Montesi <fabrizio.montesi@pm.me>
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.

2 participants