README ਜਰਨਲ
ਵਪਾਰਕ ਵਰਤੋਂ ਠੀਕ ਹੈ
581 ਮਾਡਲ
ਕੋਈ ਵਾਟਰਮਾਰਕ ਨਹੀਂ
ਕੋਈ ਸਾਈਨ-ਅੱਪ ਲੋੜੀਦਾ ਨਹੀਂ
ਮਾਡਲ:
+ GPT-5, Claude, Gemini
ਆਪਣੇ ਪ੍ਰੋਜੈਕਟ ਦਾ ਵੇਰਵਾ ਦਿਓ (ਜਾਂ package.json / pyproject.toml / Cargo.toml ਨੂੰ ਚਿਪਕਾਓ) ਅਤੇ ਇੱਕ ਸਫਲ README.md ਪ੍ਰਾਪਤ ਕਰੋ — ਸਿਰਲੇਖ, shields, ਇੰਸਟਾਲ, ਤੁਰੰਤ ਸ਼ੁਰੂ, ਫੀਚਰ, ਯੋਗਦਾਨ, ਲਾਈਸੈਂਸ। ਆਪਣੀ ਪ੍ਰੋਜੈਕਟ ਕਿਸਮ, ਲੰਬਾਈ ਅਤੇ ਟੋਨ ਚੁਣੋ।
ਤਕਨੀਕੀ ਚੋਣਾਂ
ਨਤੀਜਾ
ਟੋਕਨ ਘੱਟ ਹਨ ।
ਹੋਰ ਟੋਕਨ ਲਵੋ
❤️ Free.ai ਨੂੰ ਪਿਆਰ ਕਰੋ? ਆਪਣੇ ਦੋਸਤਾਂ ਨੂੰ ਦੱਸੋ!
ਇੱਕ ਰਿਫਰੈਸ਼ ਲਿੰਕ ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ ਸਾਈਨ ਅਪ ਕਰੋ ਅਤੇ ਹਰ ਦੋਸਤ ਲਈ 30,000 ਟੋਕਨ ਕਮਾਓ।
ਹੋਰ ਚਾਹੁੰਦੇ ਹੋ?
ਮੁਫ਼ਤ ਰਜਿਸਟਰ: 30,000 ਟੋਕਨ/ਦਿਨ
ਮੁਫ਼ਤ ਲਈ ਸਾਈਨ ਅੱਪ
ਤੁਹਾਡੀ ਮੰਗ ਪਰੋਸੈੱਸ ਕੀਤੀ ਜਾ ਰਹੀ ਹੈ...
ਮੁਫਤ AI ਨਾਲ ਪ੍ਰੋਜੈਕਟ README ਫਾਇਲਾਂ ਬਣਾਓ । ਸਕਿੰਟਾਂ ਵਿੱਚ ਪਰੋਫੈਸ਼ਨਲ ਡੌਕੂਮੈਂਟੇਸ਼ਨ ।
ਵਰਤੋਂ ਕਿਵੇਂ ਕਰੀਏ README ਜਰਨਲ
1
ਆਪਣਾ ਇੰਪੁੱਟ ਦਿਓ
ਟੈਕਸਟ ਲਿਖੋ, ਫਾਇਲ ਅੱਪਲੋਡ ਕਰੋ, ਜਾਂ ਜੋ ਤੁਸੀਂ ਚਾਹੁੰਦੇ ਹੋ ਉਹ ਦੱਸੋ । ਕੋਈ ਅਕਾਊਂਟ ਲੋੜੀਦਾ ਨਹੀਂ ਹੈ ।
2
ਕਲਿੱਕ ਬਣਾਓ
ਸਾਡੀ ਐੱਮਆਈ ਤੁਹਾਡੀਆਂ ਮੰਗਾਂ ਨੂੰ ਸਕਿੰਟਾਂ ਵਿੱਚ ਪ੍ਰਕਿਰਿਆ ਕਰ ਸਕਦੀ ਹੈ, ਇਸ ਲਈ ਅਸੀਂ ਸਭ ਤੋਂ ਵਧੀਆ ਓਪਨ-ਸੋਰਸ ਮਾਡਲਾਂ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹਾਂ।
3
ਡਾਊਨਲੋਡ ਅਤੇ ਸਾਂਝ
ਆਪਣੇ ਨਤੀਜੇ ਡਾਊਨਲੋਡ, ਕਾਪੀ ਜਾਂ ਸਾਂਝੇ ਕਰੋ । ਨਿੱਜੀ ਅਤੇ ਵਪਾਰਕ ਵਰਤੋਂ ਲਈ ਮੁਫਤ ਹੈ ।
API ਰਾਹੀਂ ਇਹ ਟੂਲ ਵਰਤੋਂ
ਇਹ ਟੂਲ ਆਪਣੇ ਕੋਡ ਤੋਂ ਆਟੋਮੈਟਿਕ ਬਣਾਓ । OpenAI- ਅਨੁਕੂਲ REST ਅੰਤ- ਬਿੰਦੂ, Bearer-token auth, ਕੋਈ ਹੋਰ SDK ਲੋੜੀਦਾ ਨਹੀਂ ਹੈ । ਟੋਕਨ ਕੀਮਤ ਵੈਬ ਇੰਟਰਫੇਸ ਨਾਲ ਮਿਲਦੀ ਹੈ ।
curl -X POST https://api.free.ai/v1/chat/ \
-H "Authorization: Bearer sk-free-..." \
-H "Content-Type: application/json" \
-d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'README ਜਰਨਲ - FAQ
ਆਪਣੇ ਪ੍ਰੋਜੈਕਟ ਦਾ ਵੇਰਵਾ 2-3 ਵਾਕਾਂ ਵਿੱਚ ਦਿਓ (ਜਾਂ package.json / pyproject.toml / Cargo.toml ਨੂੰ ਪਾਈਪ ਕਰੋ) ਅਤੇ ਇੱਕ ਚੰਗੀ ਤਰ੍ਹਾਂ ਤਿਆਰ README.md ਪ੍ਰਾਪਤ ਕਰੋ - ਸਿਰਲੇਖ, ਸਿਲਡ ਬੈਜ, ਸਮੱਗਰੀ ਟੇਬਲ, ਇੰਸਟਾਲ, ਤੁਰੰਤ ਸ਼ੁਰੂ, ਫੀਚਰ, ਵਰਤੋਂ, ਚੋਣਵੀਂ ਯੋਗਦਾਨ/ ਲਾਈਸੈਂਸ/ FAQ ਸੈਕਸ਼ਨ। ਪ੍ਰੋਜੈਕਟ ਕਿਸਮ (ਲਾਇਬਰੇਰੀ / CLI / webapp / API / ਮੋਬਾਇਲ / ਪਲੱਗਇਨ / ਡਾਟਾਸੈੱਟ / ਪੈਪਰ / ਟੈਪਲੇਟ), ਲੰਬਾਈ (ਘੱਟੋ-ਘੱਟ → ਪੂਰੀ) ਅਤੇ ਟੋਨ (ਪ੍ਰੋਫੈਸ਼ਨਲ / ਮਿੱਤਰਤਾਪੂਰਨ / ਤਕਨੀਕੀ / ਮਾਰਕੀਟਿੰਗ / ਅਕਾਦਮਿਕ) ਚੁਣੋ।
readme- so ਅਤੇ makeareadme.com ਫਾਰਮ- ਭਰਨ ਟੈਪਲੇਟ ਹਨ — ਤੁਸੀਂ ਖੁਦ ਬਕਸੇ ਚੁਣੋ ਅਤੇ ਸਟਾਕ ਸੈਕਸ਼ਨ ਪ੍ਰਾਪਤ ਕਰੋ । Free.ai ਜਨਰੇਟਿਵ ਹੈ — ਇਹ ਤੁਹਾਡੇ ਪ੍ਰੋਜੈਕਟ ਲਈ ਖਾਸ ਕਾਪੀ ਲਿਖਦਾ ਹੈ, ਤੁਹਾਡੇ ਵੇਰਵੇ ਤੋਂ ਢੁਕਵੀਆਂ ਇੰਸਟਾਲ ਕਮਾਂਡਾਂ / API ਸ਼ਕਲ / ਟੋਨ ਕੱਢਦਾ ਹੈ । Copilot ($10/mo) ਇੰਲਾਈਨ- IDE ਹੈ ਅਤੇ README ਪਾਠ ਪੈਰਾਗਰਾਮ- ਦਰ- ਪੈਰਾਗਰਾਮ ਬਣਾਉਦਾ ਹੈ ਜਿਵੇਂ ਤੁਸੀਂ ਟਾਈਪ ਕਰਦੇ ਹੋ; Free.ai ਇੱਕ ਹੀ ਵਾਰ ਵਿੱਚ ਪੂਰੀ ਫਾਇਲ ਬਣਾਉਦਾ ਹੈ । ਸਾਫ਼ ਢਾਂਚੇ ਲਈ readme- so ਵਰਤੋਂ; Free.ai ਜਦੋਂ ਤੁਸੀਂ ਅਸਲ ਕਾਪੀ ਚਾਹੁੰਦੇ ਹੋ ।
ਸਿਸਟਮ ਪਰੋਮਿਟ ਨੇ ਖਾਸ ਤੌਰ ਉੱਤੇ ਫੀਚਰ ਬਣਾਉਣ ਤੋਂ ਇਨਕਾਰ ਕੀਤਾ ਹੈ । ਜੇਕਰ ਵੇਰਵਾ ਅਸਪਸ਼ਟ ਹੈ ਤਾਂ ਮਾਡਲ "TODO" ਟਿਕਾਣਾ ਰੱਖਦਾ ਹੈ । ਹਮੇਸ਼ਾ ਤਿਆਰ README ਪੜ੍ਹੋ ਅਤੇ ਪਬਲਿਸ਼ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ TODO ਹਟਾਓ (ਜਾਂ ਅਸਲੀ ਸਮੱਗਰੀ ਨਾਲ ਬਦਲੋ) — ਆਉਟਪੁੱਟ ਨੂੰ ਇੱਕ ਸਫਾਈ ਨਾਲ ਤਿਆਰ ਪਹਿਲੀ ਡਰਾਫਟ ਦੇ ਤੌਰ ਤੇ ਵੇਖੋ, ਇੱਕ ਫਾਇਲ ਨਹੀਂ ਜੋ ਕਿ ਲਿਜਾਉਣ ਲਈ ਤਿਆਰ ਹੈ ।
ਹਾਂ, ਜਦੋਂ ਚੁਣਿਆ ਜਾਵੇ ਤਾਂ 3-6 ਸ਼ੀਲਡਾਂ ਦੀ ਇੱਕ ਕਤਾਰਾਂ (ਬਣਾਉਣਾ, ਵਰਜਨ, ਲਾਈਸੈਂਸ, ਡਾਊਨਲੋਡ, ਕਵਰੇਜ) ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਤੁਸੀਂ ਆਪਣੇ ਰਿਪੋ ਨੂੰ ਪਸੰਦੀਦਾ URL ਨਾਲ ਪਸੰਦੀਦਾ ਕਰ ਸਕਦੇ ਹੋ । ਮਾਡਲ ਪ੍ਰੋਜੈਕਟ ਕਿਸਮ ਉੱਤੇ ਅਧਾਰਿਤ ਸਹਿਜ ਡਿਫਾਲਟ ਚੁਣਦਾ ਹੈ (ਲਾਇਬਰੇਰੀ ਨੂੰ npm-version ਜਾਂ pypi-version ਮਿਲਦਾ ਹੈ; CLI ਨੂੰ ਇੰਸਟਾਲ ਗਿਣਤੀ ਮਿਲਦੀ ਹੈ; ਵੈੱਬਐਪ ਨੂੰ ਅਪਟਾਈਮ ਮਿਲਦਾ ਹੈ) ।
ਅੰਦਰੂਨੀ ਸਹੂਲਤਾਂ ਲਈ ਘੱਟੋ- ਘੱਟ (10 ਲਾਇਨਾਂ) ਜਿਨ੍ਹਾਂ ਨੂੰ ਕੋਈ ਵੀ ਖੋਜ ਨਹੀਂ ਕਰੇਗਾ । ਬਹੁਤੇ ਓਪਨ- ਸਰੋਤ ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਸਟੈਂਡਰਡ (~80 ਲਾਇਨਾਂ) - ਪਾਠ ਦੀ ਕੰਧ ਤੋਂ ਬਿਨਾਂ ਲੱਭਣਯੋਗਤਾ ਦਾ ਸੁਆਦੀ ਥਾਂ ਹੈ । ਵੇਰਵਾ (~200 ਲਾਇਨਾਂ) ਤੁਹਾਡੇ ਸਰਗਰਮ ਮਾਰਕੀਟਿੰਗ ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ । ਪੂਰੀ (docs- style, 300+ ਲਾਇਨਾਂ) ਜਦੋਂ README ਤੁਹਾਡੀ ਪ੍ਰਾਇਮਰੀ ਡੌਕੂਮੈਂਟ ਸਾਇਟ ਹੈ ।
ਹਾਂ - "ਮਾਰਕੀਟਿੰਗ" ਟੋਨ ਚੁਣੋ । ਤੁਹਾਨੂੰ ਇੱਕ ਮਜ਼ਬੂਤ ਹੈੱਡਲਾਈਨ, ਲਾਭ- ਲੈਂਡ ਕਾਪੀ, ਸਮਾਜਿਕ- ਪਰਮਾਣਿਤ ਥਾਂ- ਹਾਸਲ ਕਰਨ ਵਾਲੇ, ਮਜ਼ਬੂਤ CTAs ਮਿਲਦੇ ਹਨ । ਸੈਕਸ਼ਨ ਸਹੀ ਰਹਿੰਦੇ ਹਨ (ਕੋਈ ਨਵੀਆਂ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਨਹੀਂ) ਪਰ ਪਰਸੰਗ ਪਿੱਟ- ਸਟਾਈਲ ਹੈ । SaaS ਲਾਂਚ ਰਿਪੋਜ਼ਟਰੀ, ਪੋਰਟਫੋਲੀਓ ਪ੍ਰੋਜੈਕਟ, ਉਤਪਾਦ- ਹਿੱਟ- ਸਟਾਈਲ ਰਿਲੀਜ਼ ਲਈ ਚੰਗਾ ਹੈ ।
ਹਾਂ - "ਅਕਾਦਮਿਕ" ਟੋਨ ਚੁਣੋ । README ਵਿੱਚ BibTeX ਟੈਪਲੇਟ ਅਤੇ request- if- used ਲਾਈਨ, ਨਾਲ "ਸਵਾਗਤ" ਸੈਕਸ਼ਨ, method ਅਤੇ reproducibility ਖੇਤਰ ਸ਼ਾਮਲ ਹਨ । ਖੋਜ ਸਫ਼ਾ ਰਿਪੋਜ਼ਟਰੀ ਅਤੇ ਮਾਡਲ / ਡਾਟਾਸੈੱਟ ਰਿਲੀਜ਼ ਲਈ ਵਧੀਆ ਹੈ ।
ਹਾਂ - ਨਤੀਜਾ ਪੈਨਲ ਵਿੱਚ Markdown/Preview ਟੋਲਕ ਬਟਨ ਹਨ। ਝਲਕ ਗਿਟਹਬ-ਫਲੇਵਰਡ ਸਬ-ਸੈੱਟ ਨਾਲ ਕਲਾਇਟ-ਸਾਈਡ ਨੂੰ ਪੇਸ਼ ਕਰਦੀ ਹੈ (ਹੈੱਡਿੰਗ, ਬੋਲਡ/ਇਟਾਲਿਕ, ਕੋਡ ਬਲਾਕ, ਇੰਲਾਈਨ ਕੋਡ, ਲਿਸਟ, ਲਿੰਕ)। ਗਿਟਹਬ ਵਾਂਗ ਨਹੀਂ ਹੈ - ਹਮੇਸ਼ਾ ਇੱਕ ਰਿਪੋ ਨੂੰ ਦਬਾਉਣ ਨਾਲ ਇੱਕ ਅੰਤਮ ਟੈਸਟ ਕਰੋ।
ਡਿਫਾਲਟ ਜਰਨੈਲ ਇੱਕ ਇੱਕਲਾ ਪਰੋਜੈਕਟ README ਮੰਨਦਾ ਹੈ। ਇੱਕ monorepo root README ਲਈ, ਆਪਣੇ ਇੰਪੁੱਟ ਵਿੱਚ ਰੈਪੋ ਨੂੰ ਇੱਕ monorepo ਵਜੋਂ ਦੱਸੋ ("3 ਪੈਕੇਜ ਰੱਖਦਾ ਹੈ: foo, bar, baz") - ਮਾਡਲ ਇੱਕ ਪੈਕੇਜ ਟੇਬਲ ਸ਼ਾਮਲ ਕਰਦਾ ਹੈ ਅਤੇ ਇੰਸਟਾਲ ਕਰਨ ਲਈ ਹਟਾ ਦਿੰਦਾ ਹੈ (ਕਿਉਂਕਿ ਇੰਸਟਾਲ ਪ੍ਰਤੀ ਪੈਕੇਜ ਹੈ)। ਪ੍ਰਤੀ ਪੈਕੇਜ README ਲਈ, ਟੂਲ ਨੂੰ ਇੱਕ ਵਾਰੀ ਪ੍ਰਤੀ ਪੈਕੇਜ ਚਲਾਓ।
Qwen3ਕੋਡਰ (ਮੁਫ਼ਤ, ਡਿਫਾਲਟ) READMEs ਦੇ 95% ਨੂੰ ਚੰਗੀ ਤਰ੍ਹਾਂ ਸੰਭਾਲਦਾ ਹੈ। Qwen330B ਮਾਰਕੀਟਿੰਗ ਟੋਨ ਵਿੱਚ ਵਧੇਰੇ ਸਫਾਈ ਅਤੇ ਸੰਤੁਲਨ ਹੈ। ਪ੍ਰੀਮੀਅਮ Claude Sonnet4ਮਾਰਕੀਟਿੰਗ-ਟੋਨ ਕਾਪੀ ਅਤੇ ਪੂਰੀ ਲੰਬਾਈ READMEs ਵਿੱਚ ਕਾਫ਼ੀ ਵਧੀਆ ਹੈ - ਤੁਹਾਡੇ ਲੰਡਨ-ਪੇਜ਼ ਰਿਪੋ ਲਈ ਭੁਗਤਾਨ ਟੋਕਨਾਂ ਦੇ ਯੋਗ ਹੈ।
ਵੇਰਵਾ ਮਾਡਲ ਨੂੰ ਭੇਜਿਆ ਜਾਂਦਾ ਹੈ, ਪਰੋਸੈੱਸ ਕੀਤਾ ਜਾਂਦਾ ਹੈ ਅਤੇ ਰੱਦ ਕੀਤਾ ਜਾਂਦਾ ਹੈ । ਸੰਭਾਲਿਆ ਨਹੀਂ ਜਾਂਦਾ, ਟਰੇਨਿੰਗ ਲਈ ਵਰਤਿਆ ਨਹੀਂ ਜਾਂਦਾ ਹੈ । ਵੱਧ ਤੋਂ ਵੱਧ ਪਰਾਈਵੇਸੀ ਲਈ Qwen3ਕੋਡਰ ਚੁਣੋ - Free.ai ਦੇ GPU ਉੱਤੇ ਆਪਣਾ ਹੋਸਟ ਹੈ ।
ਹਾਂ - /v1/chat/ ਨੂੰ README ਸਿਸਟਮ ਪਰੋਮਿਟ (ਟਾਈਪ + ਲੰਬਾਈ + ਟੋਨ + ਸੈਕਸ਼ਨ ਫਲੈਗ) ਅਤੇ ਯੂਜ਼ਰ ਸੁਨੇਹੇ ਵਾਂਗ ਪ੍ਰੋਜੈਕਟ ਵੇਰਵਾ ਨਾਲ POST ਕਰੋ । ਪ੍ਰੋਜੈਕਟ ਸਕੈਫੋਲਡਿੰਗ ਦੌਰਾਨ README ਪੈਦਾ ਕਰਨ ਲਈ ਆਟੋਮੈਟਿਕ ਲਾਭਦਾਇਕ ਹੈ । /api/ ਵੇਖੋ ।
ਤੁਸੀਂ ਇਹ ਟੂਲ ਕਿਵੇਂ ਰੇਟਿੰਗ ਕਰੋਗੇ?