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

1 Update sommaire on readme #1088

Closed
wants to merge 13 commits into from

Conversation

Fr-Dae
Copy link
Contributor

@Fr-Dae Fr-Dae commented Nov 15, 2024

Fr-Dae#1
#1087
glossaire for readme and fix 3 broken link (anchor)

@pktiuk
Copy link
Member

pktiuk commented Nov 15, 2024

I don't find these changes in the readme useful. They don't improve readability and just make content list too long.

Just look at the beginning of your readme:

obraz

There is already one line under the name of the app. Adding another one just wastes space.

@Fr-Dae
Copy link
Contributor Author

Fr-Dae commented Nov 15, 2024

you know, you can asking for review change, it's more visible than a a comment on a pr or a issue

it's fix

@Fr-Dae
Copy link
Contributor Author

Fr-Dae commented Nov 15, 2024

the goal of one glossair it's to navigate quicky, because dokuwiki and mermaid generate it automatcly, but github don't (sadly) so we need make it mnually, i have zero skill in C++, but i can contribute on readme, fix link and tasks like that, like i have contribute to antimicro long time ago

- [Description](#description)
- [License](#license)
- [Installation](#installation)
- [windows](#windows)
Copy link
Member

Choose a reason for hiding this comment

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

You just added a glossary entry to paragraph, which takes literally 2 lines.

This does not make sense. That's why installation section does not have links to its subsections

@pktiuk
Copy link
Member

pktiuk commented Nov 16, 2024

the goal of one glossair it's to navigate quicky, because dokuwiki and mermaid generate it automatcly, but github don't (sadly) so we need make it mnually, i have zero skill in C++, but i can contribute on readme, fix link and tasks like that, like i have contribute to antimicro long time ago

If you don't know C++ you can still contribute in the places where contributions make sense. For example you can update Wiki or even better update AntiMicroX's web page: https://github.com/AntiMicroX/antimicrox.github.io (this one may be a bit bigger task, because in current state this website is not very useful)

@pktiuk pktiuk closed this Nov 16, 2024
@pktiuk
Copy link
Member

pktiuk commented Nov 16, 2024

Of course if you know how to make usable websites I would highly recommend taking a look at the website.

@Fr-Dae
Copy link
Contributor Author

Fr-Dae commented Nov 16, 2024

Of course if you know how to make usable websites I would highly recommend taking a look at the website.

the website need more illustration and image, but it's good

@pktiuk
Copy link
Member

pktiuk commented Nov 16, 2024

Of course if you know how to make usable websites I would highly recommend taking a look at the website.

the website need more illustration and image, but it's good

Not really it needs a lot of things like easy Download button for users or description of features. You can check issues in that repo for context: AntiMicroX/antimicrox.github.io#1 AntiMicroX/antimicrox.github.io#4

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