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

When using --source-directory, README is not parsed for index.html #196

Closed
jessesquires opened this issue Mar 26, 2015 · 2 comments · Fixed by #197
Closed

When using --source-directory, README is not parsed for index.html #196

jessesquires opened this issue Mar 26, 2015 · 2 comments · Fixed by #197
Assignees
Milestone

Comments

@jessesquires
Copy link
Contributor

The --source-directory option is now working, however the README must be in the specified directory.

As mentioned in #177, I have the following structure:

├── Example
│   ├── Example.xcodeproj
├── JSQDataSourcesKit
│   ├── JSQDataSourcesKit.xcodeproj
├── README.md

Because I specify a source directory of JSQDataSourcesKit/ for the framework, the README at the root directory is not parsed. It makes sense why this would happen, but is this expected behavior?

I'm currently working around this by including a README in JSQDataSourcesKit/, but I'm not sure if there's a better way.

@jpsim
Copy link
Collaborator

jpsim commented Mar 26, 2015

It makes sense why this would happen, but is this expected behavior?

Nope 😀! But Sam's PR just addressed this. Go Sam.

@jessesquires
Copy link
Contributor Author

awesome!

img

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

Successfully merging a pull request may close this issue.

4 participants