Bagian

Klik untuk mengedit, beralih untuk menyertakan

Judul & Deskripsi
Lencana
Fitur
Tumpukan Teknologi
Instalasi
Penggunaan/Contoh
Variabel Lingkungan
Referensi API
Penulis
Lisensi
EditorMarkdown
Pratinjau Langsung

Project Title

A brief description of what this project does and who it's for.

License Version

Features

  • Feature 1
  • Feature 2
  • Feature 3

Tech Stack

Client: React, Redux, TailwindCSS

Server: Node, Express

Installation

Install my-project with npm

  npm install my-project
  cd my-project

Usage/Examples

import Component from 'my-project'

function App() {
  return <Component />
}

Authors

License

MIT

Arsitek README ProBeta

Buat file README.md profesional dan komprehensif untuk proyek GitHub Anda dalam hitungan detik menggunakan editor visual kami. Tidak diperlukan pengetahuan Markdown.

Cara Menggunakan

1

Pilih Bagian

Pilih bagian yang Anda butuhkan untuk proyek Anda dari daftar bilah sisi.

2

Edit Konten

Isi detail untuk setiap bagian menggunakan editor sederhana di sebelah kiri.

3

Ekspor

Pratinjau README Anda secara real-time dan unduh file Markdown setelah siap.

Pertanyaan yang Sering Diajukan

Apa itu generator README?

Generator README adalah alat yang membantu pengembang membuat dokumentasi profesional untuk proyek mereka tanpa memformat kode Markdown secara manual.

Apakah alat ini gratis untuk digunakan?

Ya, Arsitek README Pro 100% gratis dan terbuka untuk digunakan semua orang.

Apakah saya perlu tahu Markdown?

Tidak, Anda tidak perlu pengetahuan Markdown yang luas. Alat kami menangani pemformatan untuk Anda.

Bisakah saya menambahkan bagian khusus?

Saat ini, Anda dapat mengedit konten bagian yang telah ditentukan sebelumnya. Kami sedang berupaya mengizinkan pembuatan bagian khusus di pembaruan mendatang.

Bagaimana cara menambahkan gambar?

Anda dapat menambahkan gambar menggunakan sintaks Markdown standar: ![Teks Alt](url). Pastikan gambar Anda di-host secara online.

Apakah ini mendukung emoji?

Ya, emoji Markdown standar GitHub-flavored didukung sepenuhnya di editor dan pratinjau.

Bisakah saya menggunakan ini untuk proyek komersial?

Tentu saja! File README yang dihasilkan adalah milik Anda untuk digunakan dalam proyek apa pun, pribadi atau komersial.

Bagaimana cara menyimpan pekerjaan saya?

Saat ini, alat ini beroperasi di browser Anda. Kami menyarankan untuk sering mengunduh README Anda untuk menyimpan kemajuan Anda.

Apakah outputnya kompatibel dengan GitLab/Bitbucket?

Ya, Markdown yang dihasilkan adalah standar dan berfungsi di GitHub, GitLab, Bitbucket, dan platform hosting kode lainnya.

Mengapa README itu penting?

README yang baik adalah wajah proyek Anda. Ini membantu orang lain memahami apa yang dilakukan kode Anda, cara menggunakannya, dan cara berkontribusi.