search

radiasoft / zgoubi

Git repo for zgoubi source code
https://sourceforge.net/projects/zgoubi/
GNU General Public License v2.0
9 stars 3 forks source link

Edit top-level README #44

Closed rouson closed 5 years ago

rouson commented 5 years ago
  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.
zbeekman commented 5 years ago

@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 commented 5 years ago

@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 commented 5 years ago

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

rouson commented 5 years ago

@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 commented 5 years ago

Sure, sounds good to me. On Wed, Oct 3, 2018 at 11:42 AM Damian Rouson notifications@github.com wrote:

@zbeekman https://github.com/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 https://github.com/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.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/radiasoft/zgoubi/pull/44#issuecomment-426685969, or mute the thread https://github.com/notifications/unsubscribe-auth/AAREPDYH6CAp8Xguu4VKxU8mydvksqLTks5uhNrUgaJpZM4W7fbR .