Suggestion: Add a release PDF manual and separate EN/FA README files

[TahaMjp]

Hi @therealaleph 👋

It’s me again 🙂

I wanted to share a simple idea that could be really helpful — both for us and for anyone who wants to use this project 💡

---

🗒️ Idea 1: Include a Manual or Instruction File

Many users, especially those who don’t have experience with GitHub or cannot access it due to government restrictions (like the Great Firewall 🚧), may find it difficult to figure out how to start using the project.

My suggestion is to include a manual or instruction file (essentially the project’s README) in a more accessible format — for example, a PDF — inside the project’s release ZIP files.

That way, when someone downloads or receives the release ZIP (even if they have no knowledge of GitHub), they can easily read the included guide and start using the project right away.

This could make the project much more user-friendly and accessible to a wider audience 🌍

---

🌐 Idea 2: Split the README into English and Farsi Versions

Another improvement could be splitting the README into two separate files —
EnReadme.md and FaReadme.md.

This structure makes it cleaner and easier for users to find the language section they prefer, without having to scroll through the entire document to locate it.

---

Thank you so much for reading 💙
I know I’ve been suggesting quite a few ideas and requests lately, but I truly believe these changes could benefit many users and strengthen our community 🙏🙂

[therealaleph]

Thanks, this is a good accessibility suggestion.

I agree with the first idea: release artifacts should include a small offline guide so someone who receives the ZIP without GitHub access can still understand what each file is and how to start. A PDF may work, but a plain README.fa.md / README.md copied into the ZIP is also useful because it stays searchable, lightweight, and easy to diff.

For the second idea, I am a bit more cautious. Splitting the repo README into fully separate English/Farsi files can reduce scrolling, but it also increases drift risk: one language gets updated and the other slowly becomes stale. A safer version may be:

• keep the current bilingual README as the canonical GitHub landing page,
• add dedicated quick-start docs, for example docs/quickstart.fa.md and docs/quickstart.md,
• include those docs in release ZIPs.

I will keep this open as a docs/release-packaging improvement. The important part is exactly what you pointed out: the project should remain usable when GitHub itself is hard to reach.

---

_{[reply via Anthropic Claude | reviewed by @therealaleph]}