#1012-update-the-boundlessflowCampus2k-readme

a24hamrh commented

2026-05-21 13:51:37 +00:00

Collaborator

Made a step-by-step on how to install the enviroment.

a24hamrh added the

needs review

label

2026-05-21 13:51:37 +00:00

a24hamrh added 1 commit

2026-05-21 13:51:37 +00:00

#1012-update-the-boundlessflowCampus2k-readme f18de487be

Made a step-by-step on how to install the enviroment.

a24hamrh referenced this pull request

2026-05-21 13:52:38 +00:00

Update The BoundlessFlowCampus2k/README.md file #1012

a24julot requested review from b24krila

2026-05-22 09:09:56 +00:00

b24krila commented

2026-05-22 09:46:33 +00:00

Collaborator

Review on #1092

Will skip the template since the changes are not that big.

The readme page works for setting up the environment by linking to the wiki pages, and its easy to follow as it follows the same flow as our wiki page. The only issue that can be found are that there are some spelling mistakes and that lowercase is used for vs code and similar instances.

But otherwise the readme file is good to go and can be merged.

### Review on #1092 Will skip the template since the changes are not that big. The readme page works for setting up the environment by linking to the wiki pages, and its easy to follow as it follows the same flow as our wiki page. The only issue that can be found are that there are some spelling mistakes and that lowercase is used for vs code and similar instances. But otherwise the readme file is good to go and can be merged.

b24krila removed the

needs review

label

2026-05-22 09:47:00 +00:00

b24krila changed title from ~~#1012-update-the-boundlessflowCampus2k-readme~~ to WIP: #1012-update-the-boundlessflowCampus2k-readme

2026-05-22 12:14:22 +00:00

b24krila changed title from ~~WIP: #1012-update-the-boundlessflowCampus2k-readme~~ to #1012-update-the-boundlessflowCampus2k-readme

2026-05-22 12:14:28 +00:00

b24krila added the

reviewed

label

2026-05-22 12:14:53 +00:00

a24julot requested review from a24timsv

2026-05-22 12:42:15 +00:00

a24timsv commented

2026-05-22 12:54:07 +00:00

Collaborator

My biggest issue is the content in general. The main README file usually present what the project is, the usage, installation guidance, license etc. Nothing is hugget i sten, but most repos follow some sort of structure that present the project as a whole.

Here are some repos that showcase what I mean:
https://github.com/FFmpeg/FFmpeg
https://github.com/anthropics/claude-plugins-official
https://github.com/torvalds/linux

We can just link to our installation page on the Wiki, and that can be it.

My biggest issue is the content in general. The main README file usually present what the project is, the usage, installation guidance, license etc. Nothing is hugget i sten, but most repos follow some sort of structure that present the project as a whole. Here are some repos that showcase what I mean: https://github.com/FFmpeg/FFmpeg https://github.com/anthropics/claude-plugins-official https://github.com/torvalds/linux We can just link to our installation page on the Wiki, and that can be it.

a24hamrh commented

2026-05-22 14:05:40 +00:00

Author

Collaborator

The description of the issue is:
"The BoundlessFlowCampus2k/README.md file should be updated to make it easier for other students to get the project running without complications"
which is what I have done.

I have no problem changing it to describe what the project is, but I think it’s a decision the project leader/issue coordinator should make, since that’s not what the issue originally set out to solve.

The description of the issue is: **"The BoundlessFlowCampus2k/README.md file should be updated to make it easier for other students to get the project running without complications**" which is what I have done. I have no problem changing it to describe what the project is, but I think it’s a decision the project leader/issue coordinator should make, since that’s not what the issue originally set out to solve.

a24timsv commented

2026-05-22 23:04:36 +00:00

Collaborator

Ahh, I did not know that. It wasn't meant to sound so harsh or personal. Sorry about that.

I think it is best to take it up with the leaders since if we describe how to get the environment going, we basically have two places that describe the same thing.

Ahh, I did not know that. It wasn't meant to sound so harsh or personal. Sorry about that. I think it is best to take it up with the leaders since if we describe how to get the environment going, we basically have two places that describe the same thing.

a24julot commented

2026-05-25 07:37:19 +00:00

Collaborator

I have seen some misspellings that should change before merge. Please double check so everything is spelled correctly and commit the changes, then I will merge this.

image.png

2.1 KiB

image.png

1.8 KiB