public/librenotes
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README with librenotes branding, build instructions, and attribution #37

New Issue
Closed
opened 2026-03-04 00:02:32 +01:00 by libretech · 0 comments
libretech commented 2026-03-04 00:02:32 +01:00
Owner
Copy Link
Copy Source

Parent

#2 (Epic: Phase 0 — Foundation)

Summary

Replace the existing Notesium README content with librenotes-specific project description, build instructions, development setup, and fork attribution. This is the public-facing project documentation that new contributors and users see first.

Acceptance Criteria

  • README.md describes librenotes (not Notesium) — project name, purpose, and features
  • Build instructions are included (go build command or Makefile targets)
  • Development setup section references the Nix flake from #6
  • Fork attribution section credits Notesium as the upstream project with link
  • License section references MIT license with proper attribution
  • CI status badge placeholder is included (to be activated after #5)

Dependencies

  • #34 (Rename Go module) — README should reference the correct module path
  • #35 (Restructure codebase) — README should reference the correct directory layout

Scope Notes

  • Does NOT include the public landing page (see #16, Phase 2)
  • Does NOT include full API or user documentation (see #29, Phase 6)
  • Does NOT include CONTRIBUTING.md (see #31, Phase 6)
  • Keep it concise — this is a project README, not comprehensive documentation
## Parent #2 (Epic: Phase 0 — Foundation) ## Summary Replace the existing Notesium README content with librenotes-specific project description, build instructions, development setup, and fork attribution. This is the public-facing project documentation that new contributors and users see first. ## Acceptance Criteria - [x] README.md describes librenotes (not Notesium) — project name, purpose, and features - [x] Build instructions are included (go build command or Makefile targets) - [x] Development setup section references the Nix flake from #6 - [x] Fork attribution section credits Notesium as the upstream project with link - [x] License section references MIT license with proper attribution - [x] CI status badge placeholder is included (to be activated after #5) ## Dependencies - #34 (Rename Go module) — README should reference the correct module path - #35 (Restructure codebase) — README should reference the correct directory layout ## Scope Notes - Does NOT include the public landing page (see #16, Phase 2) - Does NOT include full API or user documentation (see #29, Phase 6) - Does NOT include CONTRIBUTING.md (see #31, Phase 6) - Keep it concise — this is a project README, not comprehensive documentation
libretech added the phase-0documentationtask labels 2026-03-04 00:02:32 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
backend
Backend changes
 database
Database changes
 documentation
Documentation improvements
 epic
frontend
Frontend changes
 infrastructure
Infrastructure and deployment
 launch
Launch and release tasks
 phase-0
phase-1
phase-2
phase-3
phase-4
phase-5
phase-6
security
Security-related
 task
Actionable task
No labels documentation phase-0 task
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
libretech (Michael Czechowski) libretech-bot
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: public/librenotes#37