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 20:58:58 +0300
committerXavi Ablaza <xlablaza@gmail.com>2017-10-17 20:58:58 +0300
commitf0db47907e31d3ef1753b2e247096922e0f9c696 (patch)
treef0039b058193480bdd518595b6df140618313432
parent149a96106ce163ca3d675ac30621eef533911897 (diff)
Update README.md
-rw-r--r--README.md60
1 files changed, 57 insertions, 3 deletions
diff --git a/README.md b/README.md
index 31fe7b0..355dd36 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Lodi Theme
-This theme is a Hugo port of [Alexis Collado's portfolio website](http://www.alexiscollado.com). It is meant to be a single-page responsive theme, with sections for describing yourself, your
+This theme is a Hugo port of [Alexis Collado's portfolio website](http://www.alexiscollado.com). It is meant to be a portfolio theme, with sections for describing yourself, your
process, and some case studies.
![](images/screenshot.png)
@@ -16,9 +16,63 @@ $ git clone https://github.com/xaviablaza/hugo-lodi-theme.git
## Getting started
-Copy `exampleSite/config.toml` into the root of your website folder, and edit it to your hearts content!
+Copy everything within `exampleSite` into the root of your website folder, and edit it to your hearts content!
-Add `theme = "hugo-lodi-theme"` to this config, or when serving, use `hugo server -t hugo-lodi-theme`
+Add `theme = "hugo-lodi-theme"` to the `config.toml` in your root folder, or when serving, use `hugo server -t hugo-lodi-theme`
+
+## Adding a new case study
+
+```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
+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
+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
+button_links:
+ - link: "https://marvelapp.com/g4b64e/screen/14364499"
+ img: "eyeball.svg"
+ text: "View Prototype"
+ - link: "http://copenow.co/"
+ img: "eyeball.svg"
+ text: "View Landing Page"
+ - link: "cope.pdf"
+ img: "download.svg"
+ text: "Download Feature Sets"
+# A testimonial
+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: "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
+draft: false
+```
## Credits