Skip to content

Example Project for Mini-project structure and files

Notifications You must be signed in to change notification settings

heyvidy/example-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

Example Project

This is an example project for mini-projects.

Project Setup & Important Files

  1. README.md - All projects must have a README file that describes the project and documents the following:

    • What is the project about
    • How do clone and start using it on a user's system
    • Pre-requisites for the project
    • Commands for running/debugging
  2. src/source - source folder contains the actual scripts/programs that make up the project.

  3. requirements.txt - should contain a list of all the softwares/packages required run the project.

Documentation

To run this project, clone or download this project on your computer.

Navigate to the project folder

$ cd source

Run main.py to execute the program

$ python main.py

About

Example Project for Mini-project structure and files

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages