Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zig #98

Closed
wants to merge 6 commits into from
Closed

Zig #98

wants to merge 6 commits into from

Conversation

eliestroun14
Copy link
Collaborator

Description

Made some improvement in the README.

Changes include

  • Followed previous PR advices

Checklist

  • I have assigned this PR to myself
  • I have added at least 1 reviewer
  • I have tested this code
  • I have added sufficient documentation in the code

Additional comments

Please post additional comments in this section if you have them, otherwise delete it.

@eliestroun14 eliestroun14 self-assigned this Aug 12, 2024
Copy link
Contributor

@Molaryy Molaryy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good in general but you should give more details about each step.


📑 Description:

For the first exercise, we simply ask you to write `Hello world!` in your terminal when you run your program.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change write by print

📌 Tasks:

Create a file `main.zig` in a folder called `src` with your logic to print the "hello world"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should say: It should look like this 🔽


Create a file `main.zig` in a folder called `src` with your logic to print the "hello world"

src
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace:

src
└── main.zig

by

src
└── main.zig


📚 Documentation:

> 💡 Now, that you have created a file `main.zig`, you can use other zig files. To use them in your `main.zig` you have to integrate the module ([read more](https://stackoverflow.com/questions/71186556/how-do-i-include-one-zig-file-from-another-zig-file))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I already said it, rephrase this part: you can use other zig files. You should say how to include another zig packages or logic code that are in different files..


you should see the following :

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the example add the execution of the file so the user can just copy paste that.


Let's go further now!

The objective of this fifth exercise is to create a simplifying calculator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okey, I like the exercice, but you should give more details, like a graphical calculator, a interactive calculator in the terminal? You need to be the most precise possible.


Here's a typical error handeling example :

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the error message should occur instantly after he enters the information instead of waiting till he finishes.


- Create a file `calculator.zig` for this new function.

To do this, you have to make a calculator that can do:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That can do is very vast, you should give more details about the exercise. For example:

For this step you will create a interactive calculator that will take a first number, then the operation and finally the second number and once you have all the information, compute all that and print the result.

This is only an example, be more detailed.


Each todo should have at least three fields:

- id (auto-incremented)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should precise the type of each field.


Once the project has been created, you'll see the following structure:

```css
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why css, just use sh

@Molaryy Molaryy deleted the zig branch August 29, 2024 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants