Một mẫu Template cơ bản để tạo file README.md

Tram Ho

hình ảnh | 690x359

Tên dự án

Một đoạn mô tả dự án ở đây

Bắt đầu

Các hướng dẫn này sẽ giúp bạn có một bản sao của dự án và chạy trên máy cục bộ của mình cho mục đích phát triển và thử nghiệm. Xem triển khai để biết các lưu ý về cách triển khai dự án trên một hệ thống trực tiếp.

Điều kiện tiên quyết

Những thứ bạn cần để cài đặt phần mềm và cách cài đặt chúng

Cài đặt

Một loạt các ví dụ từng bước cho bạn biết làm thế nào để chạy env phát triển

Nói bước này sẽ là gì

Và lặp lại

Kết thúc với một ví dụ về việc lấy một số dữ liệu ra khỏi hệ thống hoặc sử dụng nó cho một bản demo nhỏ

Chạy thử nghiệm

Giải thích cách chạy thử nghiệm tự động cho hệ thống này

Chia nhỏ thành các bài kiểm tra kết thúc

Giải thích những gì các bài kiểm tra kiểm tra và tại sao

Và kiểm tra phong cách mã hóa

Giải thích những gì các bài kiểm tra kiểm tra và tại sao

Triển khai

Thêm ghi chú bổ sung về cách triển khai này trên hệ thống trực tiếp

Được xây dựng với

  • Dropwizard – Khung web được sử dụng
  • Maven – Quản lý phụ thuộc
  • ROME – Được sử dụng để tạo Nguồn cấp RSS

Đóng góp

Vui lòng đọc CONTRIBUTING.md để biết chi tiết về quy tắc ứng xử của chúng tôi và quy trình gửi yêu cầu kéo cho chúng tôi.

Phiên bản

Chúng tôi sử dụng SemVer để tạo phiên bản. Đối với các phiên bản có sẵn, xem các thẻ trên kho lưu trữ này .

Tác giả

  • Billie ThompsonCông việc ban đầuPurpleBooth

Xem thêm danh sách những người đóng góp đã tham gia vào dự án này.

Giấy phép

Dự án này được cấp phép theo Giấy phép MIT – xem tệp LICENSE.md để biết chi tiết

Sự nhìn nhận

  • Mũ cho bất cứ ai có mã được sử dụng
  • Cảm hứng
  • Vân vân

Qua 4rum.vn

Chia sẻ bài viết ngay

Nguồn bài viết : Viblo