Skip to content

Update README and add agent files#40

Merged
thozza merged 1 commit intomainfrom
update-readme
Apr 23, 2026
Merged

Update README and add agent files#40
thozza merged 1 commit intomainfrom
update-readme

Conversation

@lzap
Copy link
Copy Markdown
Collaborator

@lzap lzap commented Apr 10, 2026

A lot has changed but now we have a decent structure and plan, so I am updating the README to reflect that.

Also added couple of agent instruction files to use README itself.

Copy link
Copy Markdown
Member

@thozza thozza left a comment

Choose a reason for hiding this comment

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

I've added a few comments. For the agent files, I would add just AGENTS.md and make the other locations just symlinks to it. It does not make sense to have three copies of the same instructions, even if it is just a single sentence.

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
@lzap
Copy link
Copy Markdown
Collaborator Author

lzap commented Apr 17, 2026

Rebased with symlinks, applied the suggested edits.

@lzap
Copy link
Copy Markdown
Collaborator Author

lzap commented Apr 20, 2026

Rebased the conflict.

Copy link
Copy Markdown
Member

@thozza thozza left a comment

Choose a reason for hiding this comment

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

LGTM, but there is one missing newline at the end of file.

Comment thread .cursorrules
@@ -0,0 +1 @@
README.md No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

missing newline

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Not sure what github means by that :-D

$ ls -la | grep README.md
lrwxrwxrwx    1 lzap lzap     9 Apr 21 19:40 AGENTS.md -> README.md
lrwxrwxrwx    1 lzap lzap     9 Apr 21 19:40 CLAUDE.md -> README.md
lrwxrwxrwx    1 lzap lzap     9 Apr 21 19:40 .cursorrules -> README.md
-rw-r--r--    1 lzap lzap  1948 Apr 21 19:40 README.md

@lzap lzap requested a review from thozza April 23, 2026 05:44
@lzap
Copy link
Copy Markdown
Collaborator Author

lzap commented Apr 23, 2026

Not sure why github is giving us "No newline at end of file" for a symlink, technically git stores these as text files but it does not show this for the other files which are the exactly same symlinks. Let me rebase to see if that would help...

Edit: Nope.

@thozza thozza enabled auto-merge (rebase) April 23, 2026 09:31
@thozza thozza merged commit 68e0b1e into main Apr 23, 2026
1 of 3 checks passed
@thozza thozza deleted the update-readme branch April 23, 2026 09:32
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