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

Improve documentation #7

Open
rwanwork opened this issue Jun 27, 2024 · 2 comments
Open

Improve documentation #7

rwanwork opened this issue Jun 27, 2024 · 2 comments

Comments

@rwanwork
Copy link
Owner

Any corrections or improvements to any of the project's documentation would be appreciated.

This might include (but not limited to): typos, phrases that are wrong, and/or phrases that would improve understanding.

Both inline comments and the project's meta information (i.e., the README.md) can be considered.

@Th0ught09
Copy link

Th0ught09 commented Sep 28, 2024

I've started adding more robust unix commands on my fork, as well as changing some things (install location to /tmp as it is deleted on reboot as opposed to ~/tmp etc.) This is only to the README.md so far so I wouldn't want to deter any others as I've have not covered c++ in my course but could I be assigned this so long?

@rwanwork
Copy link
Owner Author

I don't mind assigning this to you, but CMake allows the user to choose the installation location at the command-line. ~/tmp was just an example -- the user is free to choose anything. I wouldn't be in favour of replacing it with /tmp in the documentation. Not because your argument is wrong...you are right! But it's just an example in the documentation and anything can be chosen.

I would suggest focussing on things that would improve a user's understanding (ie. My mistakes). And not change things based on opinion, because you and I probably have different opinions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants