Skip to content

Unclear file edit instructions in Getting started with Git #124

@yoyology

Description

@yoyology

In https://github.com/LibraryCarpentry/lc-git/blob/gh-pages/_episodes/02-getting-started.md?plain=1, starting at line 244, the instructions read, "We will open the file index.md with any text editor we have at hand (e.g. Notepad on Windows or TextEdit on Mac OSX) and enter # Hello, world!. The hash character is one way of writing a header with Markdown. Now, let’s save the file within the text editor and check if Git has spotted the changes."

Up until this point, we have done everything in Git Bash. Taking this step requires knowing where the file is located in your file system, opening it with an editor, and making changes. That's a lot of assumed knowledge packed into three sentences. Not to mention that Markdown has only been mentioned once in passing previously.

I can write different instructions here, but they would be Windows-specific, as I have almost no experience with modern Macs.

Metadata

Metadata

Assignees

Labels

help wantedLooking for Contributorstype:enhancementPropose enhancement to the lesson

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions