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

Update README + Add VIM temporary files to .gitignore #87

Merged

Conversation

TristanDamron
Copy link
Collaborator

Satisfies the acceptance criteria for #80 and #81

README.adoc Outdated
3. _Using a Bash terminal, type the following command:_

`
sh build.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line isn't rendering as a code block. try

[source]
----
sh build.sh
----

as per callouts for GFA

README.adoc Outdated
NOTE: If you receive a permissions error on *nix or macOS, prepend _sudo_ to the command. For example, type the following command:

`
sudo sh build.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same issue as line 43

README.adoc Outdated

Double-click on the index.html file that was generated in the project directory to view the site in a web browser.
`
sh serve.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same issue as line 43

@TristanDamron
Copy link
Collaborator Author

@capsulecorplab Added another commit to address your concerns.

Copy link
Member

@capsulecorplab capsulecorplab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, still not rendering correctly https://github.com/LearnTeachCode/code-coffee-compendium/blob/b0afb5a3f9ffd1e10e396c67d6bb96a8b4073364/README.adoc

try adding another dash that's sandwiching the code snippet,

[source]
----
sh command
----

@TristanDamron
Copy link
Collaborator Author

@capsulecorplab Updated my PR to fix the code blocks and to add a step for updating submodules if viewing the site locally!

Copy link
Member

@capsulecorplab capsulecorplab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

                                   ___
                                 //   \\
                                ||=====||
                                 \\___//
                                  ./O
                              ___/ //|\\
                             / o    /}
                            (       /
                            \      /
                            |     (
                            |      \
                            )       \
                           /         \
                         /            )
                       /              |
                     //             / /
                   /       ___(    ,| \
                 /       /    \     |  \
                (      /  /   /\     \  \
                \\   /___ _-_//'|     |  |
                 \\_______-/     \     \  \
                                  \-_-_-_-_-

                    "Seal of Approval"

@capsulecorplab capsulecorplab merged commit 4f2d3dc into LearnTeachCode:main Sep 1, 2021
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

Successfully merging this pull request may close these issues.

2 participants