Skip to content

improve readme.md#552

Open
dongzhuoer wants to merge 1 commit intojbeder:masterfrom
dongzhuoer:patch-3
Open

improve readme.md#552
dongzhuoer wants to merge 1 commit intojbeder:masterfrom
dongzhuoer:patch-3

Conversation

@dongzhuoer
Copy link
Copy Markdown

In the second step, I treat source directory as the src directory.

Though my version seems a little verbose, it's at least unambiguous. I think it's important to make it clear whether the user should be.

Feel free to make modifications.

In the second step, I treat `source directory` as the `src` directory. 

Though my version seems a little verbose, it's at least unambiguous. I think it's important to make it clear whether the user should be.

Feel free to make modifications.
Comment thread README.md
**Note:** If you don't use the provided installer for your platform, make sure that you add CMake's bin folder to your path.

2. Navigate into the source directory, and type:
2. clone this repository, navigate into the source directory, and make a `build` directory and navigate into it:
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

How about just inserting a new step of

"Clone the repository and navigate into the source directory"?

Also, what if someone just wants to download the tarball?

Copy link
Copy Markdown
Author

@dongzhuoer dongzhuoer Jan 18, 2018

Choose a reason for hiding this comment

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

The key point is to make it clear that the user should be at the repository directory, rather than the src directory. Maybe show the output of ls is a better solution.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

I don't know; is the original really unclear?

Copy link
Copy Markdown
Author

@dongzhuoer dongzhuoer Jan 19, 2018

Choose a reason for hiding this comment

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

Based on the fact that GitHub is a place to storage source code, you can say that the whole repository directory is the source directory. But inside it, we can also say that test is the testing directory, util is the utility directory, src is the source directory. That's why I cd into src.
Maybe you can use repository directory instead. But I think the following way will make it crystal clear. User don't have to struggle to guess the meaning of every word exactly the same as how you understand it.

mkdir build
cd build
ls
build            LICENSE    yaml-cpp-config.cmake.in
CMakeLists.txt   README.md  yaml-cpp-config-version.cmake.in
CONTRIBUTING.md  src        yaml-cpp.pc.cmake
include          test
install.txt      util

@SimplyKnownAsG
Copy link
Copy Markdown

Bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants