Skip to content

Commit

Permalink
docs: update README with additional project details and beginner notes
Browse files Browse the repository at this point in the history
- Enhance project description and goals
- Add a note for beginners to encourage and guide new learners
- Improve clarity and formatting of assignment requirements
  • Loading branch information
SaraFreitas02 committed Jan 9, 2025
1 parent a55c1ae commit 2c4dc33
Showing 1 changed file with 40 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,48 @@

---
# ODIN RECIPES
This project is part of an assignment from [**The Odin Project**](https://www.theodinproject.com/).

This project consists of an assignment from [**The Odin Project**](https://www.theodinproject.com/).
Are you new to The Odin Project? If so, be sure to check out the [`Note for Beginners`](#note-for-beginners).

<br>

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

<br>

## 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.
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.

<br>

## Assignment Requirements

This project involves creating a recipe website that adheres to the following requirements:

### Recipe Page 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
- A visually appealing `image` showcasing the finished dish.
- A brief and engaging `description` of the dish beneath the image.
- An `unordered list`of all necessary ingredients.
- An `ordered list` providing clear, step-by-step preparation instructions.

The website should:
- Contain at least 3 recipes
- Have a homepage that correctly links to each recipe
### Website Requirements:
The website must:
- Feature at least `three` unique and distinct `recipes`.
- Include a homepage with intuitive `navigation links` to each recipe page.

<br>

## 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`.
Expand All @@ -42,11 +56,28 @@ The website should:

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

<br>

## Note for Beginners
This project includes `extra features` beyond the basic assignment requirements.
If your project looks different, **don't worry or feel discouraged**. Each project is unique and reflects the developer's individual learning journey.

Focus on understanding the core concepts and completing the assignment to the best of your ability.

The goal is to learn and improve your skills, not to create an identical copy.
Keep experimenting, practicing, and don't hesitate to seek help if needed.

Happy coding!

<br>

## 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.

**Disclaimer:** Before using this material, please ensure that you fully understand the terms of the license.

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

---
Expand Down

0 comments on commit 2c4dc33

Please sign in to comment.