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

doc: clarify version control use #83

Closed
phromo opened this issue Feb 8, 2019 · 1 comment
Closed

doc: clarify version control use #83

phromo opened this issue Feb 8, 2019 · 1 comment

Comments

@phromo
Copy link

phromo commented Feb 8, 2019

Perhaps I'm approaching braid with the wrong assumptions, but could you update the docs to clarify what I'm supposed to version control and what I'm suppossed to gitignore?

Should i put the added repo files under gitignore or should I make commits? Should I version .braids.json or is it supposed to be developer-local?

If it's not local, what's the command to restore the working directory based on a .braids.json?

@realityforge
Copy link
Collaborator

braid takes the contents of a remote repository and adds them to the local repository. The tool itself will add and commit the remote branch as well as the .braids.json file.

The best way to understand the tool is to run through the Quick usage section of docs and look at what it does to the repository. HTH

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

2 participants