Skip to content

docs: update README file structure and fix typo#41

Open
omerarslan0 wants to merge 2 commits intomaderix:mainfrom
omerarslan0:docs/fix-readme-outdated-info
Open

docs: update README file structure and fix typo#41
omerarslan0 wants to merge 2 commits intomaderix:mainfrom
omerarslan0:docs/fix-readme-outdated-info

Conversation

@omerarslan0
Copy link
Copy Markdown

@omerarslan0 omerarslan0 commented Mar 4, 2026

Summary

  • Updated the file structure section to reflect the current repository layout. The existing tree was missing benchmarks/, bridge/, training_dynamic/, and several newer files (ane_classifier.h, ane_rmsnorm_bwd.h, stories_config.h, stories_cpu_ops.h, stories_io.h, stories_mil.h, dashboard.py, tokenize.py, download_data.sh, train_large_ane.m, etc.)
  • Fixed a typo in the "Fork it, build on it" section — missing space before "If" (...hear about it.If in future...hear about it. If in future)

Test plan

  • Verify the file tree in README matches the actual repo contents
  • Verify the typo fix reads correctly

Update the file structure section to reflect the current repository
layout, including benchmarks/, bridge/, training_dynamic/, and newly
added header files, scripts, and training variants. Fix missing space
in "Fork it, build on it" section.
@omerarslan0
Copy link
Copy Markdown
Author

Anybody is looking there?

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.

1 participant