Skip to content

Commit 9e9e8d7

Browse files
committed
Added more descriptive development documentation
1 parent 8b6bf59 commit 9e9e8d7

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ To set up your environment to develop this theme, run `bundle install`.
66
To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000/`. This starts a Jekyll server and that will regenerate. You should see the changes in the browser after a refresh.
77

88
## Adding a Project
9-
1. In the ~/_projects folder
9+
1. Add a new .md file to the _projects/ folder
10+
- make sure to start the file name with next number available so projects are ordered from newest to oldest
11+
2. Add a description to the .md file
12+
- copy the basic structure from the other files
13+
- any links to work/projects need to start with "/"
14+
3. Add an image for the thumbnail to the assets/images/ folder
15+
- change the "teaser" in the new .md file to match the path for your image
16+
17+
## Adding a Work Experience
18+
1. Refer to the above section about adding a project
19+
- use the _work folder instead of the _projects folder
20+
2. If you added any projects with this work, make sure they link to each other
21+
- any links to work/projects need to start with "/"
1022

1123
## Adding a Page
1224
1. In the ~/_pages folder

0 commit comments

Comments
 (0)