Skip to content

Commit

Permalink
docs: Update README with project details, assignment goals, requireme…
Browse files Browse the repository at this point in the history
…nts, and licensing information

Updates README with project details and structure

- Adds sections for assignment goals, requirements, disclaimer, and license
- Includes a table of contents for easier navigation
- Provides detailed information about the project's purpose and usage
  • Loading branch information
SaraFreitas02 committed Jan 8, 2025
1 parent e744472 commit 4e32245
Showing 1 changed file with 51 additions and 3 deletions.
54 changes: 51 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
This repository is an assignment from The Odin Project.
`This README file will be updated with more details soon.`

This README file will be updated with more details soon.
---
# ODIN RECIPES

Make sure to checkout the [DISCLAIMERS](DISCLAIMER.md) and the [LICENSE](LICENSE) in the meantime.
This project consists of an assignment from [**The Odin Project**](https://www.theodinproject.com/).

| **Table of Contents** |
|-----------------------|
| [Assignment Goal](#assignment-goal) |
| [Assignment Requirements](#assignment-requirements) |
| [Disclaimer](#disclaimer) |
| [License](#license) |


## Assignment Goal

The goal of this assignment was to create a simple recipe website using HTML. This project helped practice the basics of HTML, including creating lists, linking pages, and embedding images.

## Assignment Requirements

Each recipe page should include:
- An image of the finished dish
- A description of the image below it
- An unordered list of ingredients
- An ordered list of preparation steps

The website should:
- Contain at least 3 recipes
- Have a homepage that correctly links to each recipe

## DISCLAIMER
- The information in this document and repository is for `educational purposes and personal learning` as part of an assignment from The Odin Project.

- While the structure or topics may be similar to the assignments, the `code and implementation are original`.

- `Recipes are sourced from All Recipes` and used solely for educational purposes.

- The content is provided "as is" `without warranties` and may not be suitable for production use. The `user assumes all responsibility` for ensuring the code and content meet their requirements.

- The authors or contributors are `not liable for any damages` arising from the use or inability to use the information provided.

For more information visit the [Disclaimers File](DISCLAIMER.md).

## LICENSE
This project is licensed under the **MIT License**, which permits use, copying, modification, merging, publishing, distribution, sublicensing, and selling copies of the software.

The software is provided "as is", without warranty of any kind.

For more details, visit the [License file](LICENSE).

---
`This README file will be updated with more details soon.`

0 comments on commit 4e32245

Please sign in to comment.