Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/xaviablaza/hugo-lodi-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Ablaza <xlablaza@gmail.com>2017-10-17 22:16:14 +0300
committerXavi Ablaza <xlablaza@gmail.com>2017-10-17 22:16:14 +0300
commit925e844d1470b6fcb19abaa1e5f448066ebae37a (patch)
tree6b5d3ab28a6c4f70a5e32f91a48b11e26f261239
parentdba79e12b67eeb244fa70bbae893e6d56dc0114a (diff)
Update README.md with archetype instructions
-rw-r--r--README.md44
1 files changed, 39 insertions, 5 deletions
diff --git a/README.md b/README.md
index 355dd36..e080fee 100644
--- a/README.md
+++ b/README.md
@@ -22,36 +22,60 @@ Add `theme = "hugo-lodi-theme"` to the `config.toml` in your root folder, or wh
## Adding a new case study
+At the root of your Hugo site, you can use
+```sh
+$ hugo new mypost.md
+```
+to generate a new case study post. To find the post, you can go to `content/mypost.md` and you can use that file to write details about your case study and the body of your case study in markdown.
+
```yaml
+---
# This determines what shows up first, lower weight = shows up first
weight: 1
+
# This is what appears as the tab's title
title: "Cope | Alexis Collado"
+
# This is the description in the <head> tag
description: "I set a direction for the branding and identity of the product and crafted a functioning prototype ready for usability testing and development."
+
# This the heading of the navigation at the top of the case study
nav_heading: "Cope Case Study"
-# This is what appears in the case studies section, place your image at the root of the static folder
+
+# This is what appears in the case studies section, place this image at the /static/img folder
thumbnail: "cope.jpg"
+
# This is the title of the case study in the case studies section
case_short_title: "Cope iOS App"
+
# This is the title of the case study in the case study page
case_title: "Cope iOS App"
+
# This is the subtitle of the case study in the case studies section and the case study page
case_subtitle: "Mobile App Design"
+
# This is the case description in the case studies section
case_description: "Cope is a mobile app that allows mental health help seekers track their symptoms and medication. I helped them create a minimum viable product for testing."
-# This is the featured image of the case
+
+# This is the featured image of the case, place this image at /post_title_here/img folder
+# e.g. /mypost/img
case_feature_img: "featured-cope.jpg"
+
# This is the case summary in the case itself
case_summary: "Cope is an application that helps users track their mental health. Progress is measured through the use of a check-in system, calendar, medicine tracker and a summary dashboard. I created a minimum viable product for this application."
+
# Your team members
team: ["Alexis Collado", "Carlos Arcenas", "Kat Uytiepo", "John Palomo"]
+
# Roles of your team members
roles: ["Branding and Identity", "User Interface Design", "Prototyping", "User Research"]
+
# Methods your team members used
methods: ["Sketching", "Mockups", "Guerilla Testing"]
+
# Links at the bottom of the case study and where they link to
+# img is the svg that's part of the button. You can use eyeball.svg or download.svg
+# Place your custom svgs into /static/svg
button_links:
- link: "https://marvelapp.com/g4b64e/screen/14364499"
img: "eyeball.svg"
@@ -62,16 +86,26 @@ button_links:
- link: "cope.pdf"
img: "download.svg"
text: "Download Feature Sets"
-# A testimonial
+
+# Testimonial text
testimonial: "Alexis designed everything for Cope from the ground up. What I really like about him is his true understanding and grasp of what makes a great UI great. He knows that the user experience needs a lot of refining from customers and he isn't shy to take feedback even if it's critical. Alexis is one of those rare people who just gets it."
-# Testimonial photo
+
+# Testimonial photo, place this at /post_title_here/img
+# e.g. /mypost/img
testimonial_photo: "john.jpg"
+
# Author of testimonial
testimonial_author: "John Robert Palomo"
+
# Testimonial subtitle, usually position of the testimonial author
testimonial_subtitle: "Co-founder, Cope"
-date: 2017-10-15T03:29:08-07:00
+
+date: {{ .Date }}
draft: false
+
+# Write the content of your case study below the three dashed lines. You can use markdown and raw HTML.
+---
+
```
## Credits