Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
annyang1963 authored Aug 13, 2021
1 parent b30b3b6 commit 927928b
Showing 1 changed file with 0 additions and 36 deletions.
36 changes: 0 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1 @@
# Purpose of This Repo

This repo is meant to be used to keep things organized during content development and act as the source of truth for all projects and exercises related to this course.

## Folder Structure

### Lesson Folder

This repo contains a folder for each `lesson` and one `project` folder.

Example
```
lesson-1-hello
lesson-2-world
lesson-3-foo
lesson-4-bar
project
```

Each `lesson` folder is named using the naming convention of `lesson-#-name-of-lesson`.

Example
```
lesson-1-hello
```

Four lesson folders have been provided as a template; However, you may need to add more or possibly use less than four depending on what is needed.

If you require an additional lesson folder, you can make a copy of the folder and paste it into the root directory.

### Exercises Folder

Each `lesson` folder contains an `exercises` folder. This `exercises` folder should contain all files and instructions necessary for the exercises along with the solution. The solutions for these exercises will be shared with students. See the `README` in the `exercises` folder for information about folder structure.

### Project Folder

The `project` folder should contain all files and instructions necessary for setup. If possible, a set of instructions should be provided for both Udacity workspaces and a way to work locally (for both MacOS and Windows OS). At a minimum, one set of instructions should be provided. A `README` template has been provided in the project folder. This template layout should be used to write your README.

0 comments on commit 927928b

Please sign in to comment.