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

Edit top-level README #44

Merged
merged 4 commits into from
Oct 5, 2018
Merged

Edit top-level README #44

merged 4 commits into from
Oct 5, 2018

Conversation

rouson
Copy link
Contributor

@rouson rouson commented Sep 26, 2018

  1. Rename README as README.md to exploit GitHub-flavored Markdown.
  2. Format with Markdown, including inserting hyperlinks.
  3. Add zgoubi build instructions and docker image launch instructions.

1. Format with GitHub-flavored Markdown
2. Add zgoubi build instructions
@zbeekman
Copy link
Contributor

@rouson: What is this issue you're having with the docker build? Can you run ./travis.sh? Or are you having trouble building interactively in the docker image?

@zbeekman
Copy link
Contributor

@rouson I reviewed the README, and I made some minor formatting, white space and spelling/typo corrections. The instructions look correct to me. Please elaborate on the behavior you're experiencing when you say

Because I can't currently build inside docker, the instructions in this README.md are likely incorrect or incomplete.

@zbeekman
Copy link
Contributor

zbeekman commented Oct 3, 2018

This looks like it's ready to merge. @rouson are we waiting on review from @robnagler and/or @dtabell?

@rouson
Copy link
Contributor Author

rouson commented Oct 3, 2018

@zbeekman Thanks for the corrections. One needs to be reverted, however: "exemples" is the name of the referenced directory and the correct spelling in French. I'll push that change. @dtabell and I have been corresponding about this pull request on slack and will go over it the next time he and I talk so let's leave it open a bit longer.

@zbeekman
Copy link
Contributor

zbeekman commented Oct 3, 2018 via email

The build instructions and the`docker` command given in this file now work for me so this is ready to merge.
@rouson rouson changed the title WIP: Edit top-level README Edit top-level README Oct 5, 2018
@rouson rouson merged commit fd7d70f into master Oct 5, 2018
@rouson rouson deleted the update-top-level-README branch October 5, 2018 00:16
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.

2 participants