Projelerinize hızlı bir başlangıç yapmak için harika bir BENİOKU şablonu!
Dökümanları Keşfedin »
Demo'yu Gör
·
Hataları Raporla
·
Özellik İstekleri
İçindekiler
GitHub'da birçok harika README şablonu mevcuttur; ancak, ihtiyaçlarıma gerçekten uyan bir tane bulamadım, bu yüzden bu geliştirilmiş olanı oluşturdum. O kadar harika bir BENİOKU şablonu oluşturmak istiyorum ki ihtiyacınız olan son şablon bu olacak -- Sanırım bu kadar.
İşte nedeni:
Zamanınız harika bir şey üretmeye odaklanmalıdır. Bir sorunu çözen ve başkalarına yardımcı olan bir proje sıfırdan bir BENİOKU oluşturmak gibi aynı görevleri tekrar tekrar yapmamalısınız. DRY ilkelerini hayatınızın geri kalanına uygulamalısınız. :)
Elbette, ihtiyaçlarınız farklı olabileceğinden, tek bir şablon tüm projelere hizmet etmeyecektir. Bu yüzden yakın gelecekte daha fazlasını ekleyeceğim. Ayrıca bu repoyu çatallayarak ve bir çekme isteği oluşturarak veya bir sorun açarak değişiklik önerebilirsiniz. Bu şablonun genişletilmesine katkıda bulunan herkese teşekkürler!
Başlamak için BLANK_README.md öğesini kullanın.
(başa dön)
Bu bölüm, projenizi önyüklemek için kullanılan tüm büyük çerçeveleri/kütüphaneleri listelemelidir. Tüm eklentileri/eklentileri teşekkür bölümü için bırakın. İşte birkaç örnek.
(başa dön)
Bu, projenizi yerel olarak kurmaya ilişkin talimatları nasıl verebileceğinize bir örnektir. Yerel bir kopyayı çalışır duruma getirmek için bu basit örnek adımları izleyin.
Bu, yazılımı kullanmak için ihtiyaç duyduğunuz şeylerin nasıl listeleneceğine ve bunların nasıl kurulacağına bir örnektir.
- npm
npm install npm@latest -g
Aşağıda, kitlenize uygulamanızı yükleme ve kurma konusunda nasıl talimat verebileceğinize dair bir örnek verilmiştir. Bu şablon herhangi bir dış bağımlılığa veya hizmete dayanmaz..
- https://example.com adresinden ücretsiz bir API Anahtarı edinin.
- Depoyu klonla
git clone https://github.com/your_username_/Project-Name.git
- NPM paketlerini kurun
npm install
- API'nizi girin
config.jsconst API_KEY = 'ENTER YOUR API';
(başa dön)
Bir projenin nasıl kullanılabileceğine dair yararlı örnekler göstermek için bu alanı kullanın. Ek ekran görüntüleri, kod örnekleri ve demolar bu alanda iyi çalışır. Ayrıca daha fazla kaynağa da bağlantı verebilirsiniz.
Daha fazla örnek için lütfen Belgelere bakın. Documentation
(başa dön)
- Değişiklik günlüğü ekle
- Başa dön bağlantılarını ekle
- Örneklerle Ek Şablonlar Ekleyin
- Benioku'nun bölümlerini kolayca kopyalayıp yapıştırmak için "bileşenler" belgesi ekleyin
- Çoklu Dil Desteği
- İngilizce
- Arapça
Önerilen özelliklerin (ve bilinen sorunların) tam listesi için open issues (açık sorunlara) bakın.
(başa dön)
Katkılar, açık kaynak topluluğunu öğrenmek, ilham vermek ve yaratmak için harika bir yer yapan şeydir. Yaptığınız katkılar gerçekten çok değerlidir.
Bunu daha iyi hale getirecek bir öneriniz varsa, lütfen repoyu çatallayın ve bir çekme isteği oluşturun. Ayrıca "geliştirme" etiketiyle bir sorun açabilirsiniz. Projeye yıldız vermeyi unutmayın! Tekrar teşekkürler!
- Projeyi Çatallayın
- Özellik Dalınızı Oluşturun (
git checkout -b feature/AmazingFeature) - Değişikliklerinizi Gerçekleştirin (
git commit -m 'Add some AmazingFeature') - Şubeye Gönder (
git push origin feature/AmazingFeature) - Bir Çekme İsteği Aç
(başa dön)
MIT Lisansı altında dağıtılmaktadır. Daha fazla bilgi için lütfen LICENSE.txt bakınız.
(başa dön)
Adınız - @your_twitter - email@example.com
Proje Bağlantısı: https://github.com/your_username/repo_name
(başa dön)
Yararlı bulduğunuz ve kaynak göstermek istediğiniz kaynakları listelemek için bu alanı kullanın. İşleri başlatmak için favorilerimden birkaçını dahil ettim!!
- Choose an Open Source License
- X Technology Inc.
- GitHub Emoji Cheat Sheet
- Malven's Flexbox Cheatsheet
- Malven's Grid Cheatsheet
- Img Shields
- GitHub Pages
- Font Awesome
- React Icons
(başa dön)