Giters

GiovaniValdrighi / template-readme

Template for the READMEs file of my projects.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Name of the project: README Template

This is my template for the README file of my projects avaiable at Github. This file will contain the general organization of topics and Markdown formatting for the README file of other projects. The organization is based on references found on the internet and my preferences.

Files organization

The files of the project are separated in the following folders:

  • docs/: documentation of the project.

  • src/: main files of the programming language.

Requirements

You must install the following programs to be able to run my code:

  1. (Notepad)[https://en.wikipedia.org/wiki/Windows_Notepad]

How to run

  1. Run the file in /src/file.py and run the following command on the terminal:

python3 file

Reference

This template is based on references found (online)[https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md].

About

Template for the READMEs file of my projects.