harm-smits / 42docs Goto Github PK

• Update getting started
• Update the prototypes

To improve the type-hinting of MLX we should add IDE stubs with proper CDoc

Hello,

Thank you very much for your documentation regarding MLX. It has been very useful to me, and I'm sure to plenty others.
There's an error in section Getting Started > Getting a screen on WSL(2).
Upon opening XLaunch, user should choose "Start no client" option, rather than "Start a program" as stated in the documentation.

Thank you again!

Personally I found the MLX docs a little hard to read and would advice rewriting the explanation (not the inherent content)

Currently its set up as a tutorial series which is fine but isn't really in my opininion how documentation should work. A student should be free to try things for themselves with the docs providing the information on how to use those functions.

I'd take an example out of the react docs and compare how their more formal approach can bring a legible explanation to the features. https://reactjs.org/docs/introducing-jsx.html

(React Router)[https://reactrouterdotcom.fly.dev/] also has a nice way of splitting the docs in half by letting you choose between a tutorial and the complete docs

If this is something you are open for I would love to help and we can bounce ideas back and forth.

After having read docs for close to 5 years I have a sense of what works and what doesn't after also having to write docs for internships and new developers at companies.

Hope to hear from you.

slack: rnijhuis

In "Getting started", second snippet: the window doesn't pop up while using sleep(). Works with mlx_loop(), but some workarounds have to be done to close the window without stopping it in the terminal manually.

#include <mlx.h>
#include <stdlib.h>

int 	exit2()
{
	exit(0);
}

int     main(void)
{
	void    *mlx;
	void    *mlx_win;

	mlx = mlx_init();
	mlx_win = mlx_new_window(mlx, 1920, 1080, "Hello world!");
	mlx_hook(mlx_win, 17, 0, exit2, mlx);
	mlx_loop(mlx);
}

#include <stdio.h>

int	create_trgb(int t, int r, int g, int b)
{
	return (t << 24 | r << 16 | g << 8 | b);
}

int	get_t(int trgb)
{
	return (trgb & (0xFF << 24));
}

int	get_r(int trgb)
{
	return (trgb & (0xFF << 16));
}

int	get_g(int trgb)
{
	return (trgb & (0xFF << 8));
}

int	get_b(int trgb)
{
	return (trgb & 0xFF);
}

int main()
{
	int trgb = create_trgb(248, 12, 100, 200);
	printf("%d\n", trgb);
	printf("%d\n", get_t(trgb));
	printf("%d\n", get_r(trgb));
	printf("%d\n", get_g(trgb));
	printf("%d\n", get_b(trgb));

    return 0;
}

output:

-133405496
-134217728
786432
25600
200

Should be:

int	get_t(int trgb)
{
	return ((trgb >> 24) & 0xFF);
}

int	get_r(int trgb)
{
	return ((trgb >> 16) & 0xFF);
}

int	get_g(int trgb)
{
	return ((trgb >> 8) & 0xFF);
}

int main()
{
	int trgb = create_trgb(248, 12, 100, 200);

output:

-133405496
248
12
100
200

1. When installing on ubuntu 18.04 WSL2, resolvconf does not seem to be installed yet. This causes issues with:
   export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0.0

since the file /etc/resolv.conf doesn't exist. Dependency installation in previous subchapter Compilation on Linux can be changed too
sudo apt-get update && sudo apt-get install xorg libxext-dev zlib1g-dev resolvconf

2. When using Xming and opening Xlaunch, the default configuration will put "xterm" as default Start program option. Keeping this there and then finishing will result in an error and Xserver quiting. To solve this, keep this option empty as shown in the screenshot:
   

Currently the docs for get next line are incorrect in a couple ways because the subject has changed since initial writing of the docs.

The prototype is incorrect as it now only requires a file descriptor and the return value has updated:
int get_next_line(int fd, char **line); -> char *get_next_line(int fd);

The return value needs to be updated to say it should return a char pointer with the newline included if there is a newline the line. If there isn't any data to be read anymore it should return a NULL value.

Typo