Merge branch 'main' of github.com:MLOPS-Teaching/mlops-coding-course

docs/1. Initializing/1.0. Starting up.md

@@ -0,0 +1,33 @@
+# Initialization
+
+This section introduces many basic concepts common to all software projects, which also apply to MLOps
+
+## Learning Objectives
+
+- Setting the environment
+- Versionning
+- Documentation and Licensing
+
+## Prerequisites
+
+None
+
+## Overview
+
+Provide a brief overview of what will be covered in this course section.
+
+## Topics Covered
+
+- Topic 1
+- Topic 2
+- Topic 3
+
+## Resources
+
+- Resource 1
+- Resource 2
+- Resource 3
+
+## Conclusion
+
+Summarize the key points covered in this course section.

docs/1. Initializing/1.1. README.md

@@ -0,0 +1,52 @@
+# 1.0. README.md
+
+## What is a README.md file?
+
+A README.md file serves as the introductory document for your project repository. 
+It's similar to the welcoming mat at your front door, offering a first glimpse into your project.
+Beyond a simple description, it conveys the main things to know about your project, guiding users and contributors on how to interact with it.
+
+## How is it written ?
+
+README.*md* are written in Markdown, a markup language that simplify the writting and formatting of your documentation. Markdown is not cover in this class, but you canfind resources there [link](https://www.markdownguide.org/).
+
+
+## Why do I need a README.md file?
+
+The simplest answer is because you are not the only one that will interact with your project, and even if that were to be the case, akin to code comments, coming back to your project after couple of months you will likely appreciate the presence of a readme to remind you about the main point.
+
+
+More generally, a good README.md file is crucial as it establish the first impression of your work (and first impression do matter). 
+So carefull consideration should be put in the information encompass and the way they are presented.
+
+## What should I put in my README.md file?
+
+Typically, we find the following informations:
+- Detailed project overview (title, overview, history, version, build, status, ...)
+- Key features and functionalities
+- Visual elements like logos or screenshots
+- How to install/set up/use the project
+
+
+## When should I write my README.md file?
+
+Simply put, try to write alongside your development.
+The README.md will evolve with your project status. Initially, it may be simple:
+
+```markdown
+# My AI/ML Project
+
+Discover the power of AI and ML with this innovative project.
+```
+
+As development progresses, you might enrich it with:
+- **Capabilities**: What unique solutions does your project offer?
+- **Installation Guide**: Step-by-step instructions for setting up.
+- **Usage Instructions**: Clear examples of how to use the project.
+
+## How can I get more tips on writing a README.md file?
+
+For further enhancement of your README.md, consider these resources:
+- [Make a README](https://www.makeareadme.com/): A comprehensive guide with best practices and examples.
+- [Awesome README](https://github.com/matiassingers/awesome-readme): A curated list of awesome READMEs with creative and technical insights.
+- [README Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2): A template to kick-start your README creation process.