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

Simplify README #4766

Closed
Closed

Conversation

Disservin
Copy link
Member

@Disservin Disservin commented Aug 26, 2023

The UCI protocol is rather technical and has little value in our README. Instead
it should be explained in our wiki. "Contributing" is moved above "Compiling
Stockfish" to make it more prominent.

Also move the CONTRIBUTING.md into the root directory and include it in the
distributed artifacts/releases.

@Disservin Disservin changed the title Remove uci paragraph from readme Simplify README Aug 26, 2023
@dav1312
Copy link
Contributor

dav1312 commented Aug 26, 2023

Note that you renamed the commands wiki page but didn't update the link in the readme and now you are moving the contributing file but are not updating the links either

@Disservin
Copy link
Member Author

Note that you renamed the commands wiki page but didn't update the link in the readme and now you are moving the contributing file but are not updating the links either

The readme doesnt link to the commands anymore, but I should remove the old link variable(or whatever it is called) and yeah i'll fix the link to the readme and check which links need to be adjusted in the wiki

The UCI protocol is rather technical and has little value in our README. Instead
it should be explained in our wiki. "Contributing" is moved above "Compiling
Stockfish" to make it more prominent.

Also move the CONTRIBUTING.md into the root directory and include it in the
distributed artifacts/releases.
@snicolet
Copy link
Member

It is quite nice to have moved the CONTRIBUTING.md file in the main repo, thanks :-)
Does it break anything if we make the .github repo private after that?

@snicolet snicolet added the to be merged Will be merged shortly label Sep 3, 2023
@snicolet snicolet closed this in 4f7fe25 Sep 3, 2023
@snicolet
Copy link
Member

snicolet commented Sep 3, 2023

merged via 4f7fe25, thanks :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-bench-change to be merged Will be merged shortly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants