Skip to content

Commit

Permalink
Merge pull request #20 from girldevelopit/update-apr2023v1
Browse files Browse the repository at this point in the history
Slight updates to README
  • Loading branch information
tinuola authored Apr 3, 2023
2 parents 6d56593 + e6f928a commit c040e56
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## This is a template repository for Girl Develop It's track or subject-matter repositories.
## This is a template or model repository for Girl Develop It's technical track repos.

To prevent _**'repo sprawl'**_ (creating repos for individual courses), GDI has track- or subject-matter-specific repositories that contain individual courses:
To prevent _"repo sprawl"_ (creating repos for individual courses), GDI has track- or subject-matter-specific repositories that contain individual courses:

- [HTML & CSS](https://github.com/girldevelopit/gdi-html-css)
- [JavaScript](https://github.com/girldevelopit/gdi-javascript)
Expand All @@ -9,17 +9,17 @@ To prevent _**'repo sprawl'**_ (creating repos for individual courses), GDI has
- [Data Science](https://github.com/girldevelopit/gdi-data-science)
- [Tech 101](https://github.com/girldevelopit/gdi-tech101)

#### :exclamation: Use this template repo to create a new track or subject-matter repository, NOT a new course.
#### :exclamation: Use this template repo to create a new technical track or subject-matter repository; do not use this template to start a new course.

- To start a new course, go to a specific track repo and use the `_course-template` folder in that repo.
- To start a new course, go to a specific track repo (_see the list above_) and use the `_course-template` folder in that repo.

## Content

This template repo contains a `_course-template` folder and a `shared-assets` folder
This template repo contains a `_course-template` folder and a `shared-assets` folder.

The `_course-template` folder is the template for creating **individual courses** that go into the primary track or subject-matter repository.
The `_course-template` folder is the template for creating **individual courses** that go into the primary track or subject-matter repo.

- The course template folder includes a [README](/_course-template/README.md) with instructions for creating courses
- The `_course-template` folder includes a [README](/_course-template/README.md) with instructions for creating courses.

The `shared-assets` folder holds custom GDI `css`, `images`, `js` files that **all** course folders in a primary track repo reference.

Expand All @@ -40,14 +40,14 @@ To create a new track or subject-matter repo:

- Duplicate the `_course-template` folder to create or start new courses

- :exclamation: Do not delete the `_course-template` folder; it should always be available to create other course
- :exclamation: Do not delete the `_course-template` folder; it should always be available to create other courses
- A track repo can contain more than one course
<br>

- Make sure to also include/keep the `shared-assets` folder in the new repo
- Make sure to include/keep the `shared-assets` folder in the new repo
<br>

- Create an empty `.nojekyll` file in the new repo's root directory; this allows the repo to [bypass Jekyll processing for Github Pages](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)
- Create a `.gitignore` file in the new repo's root directory to exclude hidden system files
<br>

- Create a `.gitignore` file in the new repo's root directory to exclude hidden system files
- RECOMMENDED: Create an empty `.nojekyll` file in the new repo's root directory; this allows the repo to [bypass Jekyll processing for Github Pages](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)

0 comments on commit c040e56

Please sign in to comment.