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

Add a Readme #16

Open
baileythegreen opened this issue Apr 14, 2021 · 3 comments
Open

Add a Readme #16

baileythegreen opened this issue Apr 14, 2021 · 3 comments

Comments

@baileythegreen
Copy link
Contributor

and a description to this repo, because it should have one and because people unfamiliar with Jekyll don't stand a chance at figuring out its purpose without either of them.

It looks like USAGE.md is essentially a Readme, but it doesn't get previewed because it's not named Readme, and it may not be obvious to people to look there to understand the purpose of the repo.

@bkmgit
Copy link
Contributor

bkmgit commented Apr 22, 2021

related to #3

@bkmgit
Copy link
Contributor

bkmgit commented Apr 22, 2021

The about section of the styles repository indicates there is no README to avoid conflicts, probably same reason for USAGE.md instead of README.md Perhaps the about section of this repository can be updated?

@klieret
Copy link

klieret commented Jul 26, 2021

It's different with the styles repository: The styles repository is meant to be used as a template repository and you want to be able to merge changes from the styles repository into the other repositories of the individual lessons afterwards. Hence, if you

  1. add readme to styles,
  2. start a lesson with the styles repository as template,
  3. then change the lesson readme,
  4. also change the styles readme along with other changes
  5. you now merge the styles repository into the lesson repository to get these changes

you have a merge conflict.

This shouldn't happen here.

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

No branches or pull requests

3 participants