Add readme; add copyright

8 files changed, 180 insertions, 1 deletions

diff --git a/README.md b/README.md
index 3662042..731bb8c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,44 @@
 # cv-almeida
-Theme to build a customizeable printable CV with minor web responsiveness.
+Theme to build a customizeable printable HTML/CSS CV.
+
+# Features
+ - Online CV with minor responsiveness
+ - Printable as A4 PDF
+
+# Download 
+Clone the repo: `git clone https://github.com/ineesalmeida/cv-almeida`
+
+# Installation
+## Install Hugo
+To use cv-almeida theme you need to install Hugo by following https://gohugo.io/getting-started/installing/.
+
+## Create your personal website and run
+```
+hugo new site <your website's name>
+cd <your website's name>/themes/
+```
+Clone the theme (`git clone https://github.com/ineesalmeida/cv-almeida`).
+Replace the "config.toml" file that in the project's root directory with `themes/cv-almeida/exampleSite/config.toml`.
+Replace the "content.yaml" file that in the project's root directory with `themes/cv-almeida/exampleSite/data/content.yaml`.
+```
+hugo server -D
+```
+The theme is alive on http://localhost:1313/ 
+
+## Customization
+You can change the theme colors in the `config.toml` file.
+Your professional data should be added in the `data/content.yaml`.
+
+# Building 
+To generate your site in the public folder, execute the following:
+```
+hugo
+```
+within the root of your project.
+
+
+# Contributing 
+Post bugs and contributions to the issue tracker. Or make a pull request.
+
+# License 
+This template is 100% FREE as long as you keep the footer attribution link. You do not have the rights to resell, sublicense or redistribute (even for free) the template on its own or as a separate attachment from any of your work. If you’d like to use this template without the footer attribution link, you can buy the commercial license. Send an email to contact@ines-almeida.com.
\ No newline at end of file
diff --git a/assets/sass/_layout.scss b/assets/sass/_layout.scss
index cc7a712..ed3dad8 100644
--- a/assets/sass/_layout.scss
+++ b/assets/sass/_layout.scss
@@ -7,6 +7,17 @@
         width: $width-left-col;
         height: 100%;
         padding: 3rem 4rem;
+
+        @media print {
+            &::after{
+                content: "2020 © by Inês Almeida   |   ines-almeida.com";
+                height: 4rem;
+                width: 100%;
+                position: absolute;
+                bottom: 0.5rem;
+                color: $color-grey;
+            }
+        }
     }
 
     &__right {
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
new file mode 100644
index 0000000..67ba84d
--- /dev/null
+++ b/exampleSite/config.toml
@@ -0,0 +1,10 @@
+baseURL = "cv/"
+languageCode = "en-us"
+title = "Inês Almeida - CV"
+theme = "cv-almeida"
+
+[params]
+colorPrimary = "#e3bfb8"
+colorPrimaryText = "#fff"
+colorPageBackground = "#ddd"
+colorRightColumnBackground = "#f5f5f5"
diff --git a/exampleSite/data/content.yaml b/exampleSite/data/content.yaml
new file mode 100644
index 0000000..8779390
--- /dev/null
+++ b/exampleSite/data/content.yaml
@@ -0,0 +1,116 @@
+BasicInfo:
+  FirstName: Inês
+  LastName: Almeida
+  Photo: img/avatar.jpg
+  Contacts:
+    - Icon: fas fa-phone
+      Info: +44 123 456 789
+    - Icon: fas fa-envelope
+      Info: contact@ines-almeida.com
+    - Icon: fas fa-globe
+      Info: ines-almeida.com
+    - Icon: fas fa-map-marker-alt
+      Info: Portugal
+
+Profile: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
+
+Experience:
+  - Employer: Super Cool Company
+    Place: Oxford, UK
+    Positions:
+      - Title: Software Engineer
+        Date: Jan 2020 - Present
+        Details:
+          - Arcu vitae elementum curabitur vitae nunc sed velit
+          - Viverra aliquet eget sit amet tellus cras adipiscing
+          - Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat
+          - Nisl tincidunt eget nullam non nisi est
+          - Sed viverra tellus in hac.
+          - Lorem ipsum dolor sit amet, consectetur adipiscing elit
+        Badges: ['Python', 'Django', 'OOP', 'Javascript', 'HTML', 'CSS', 'Agile']
+      - Title: Software Tester
+        Date: Mar 2019 - Jan 2020
+        Details:
+          - Nisl tincidunt eget nullam non nisi est
+          - Sed viverra tellus in hac.
+          - Lorem ipsum dolor sit amet, consectetur adipiscing elit
+        Badges: ['Python', 'BDD', 'Selenium', 'OOP', 'Agile']
+  - Employer: Another super cool company
+    Place: Lisbon, PT
+    Positions:
+      - Title: Flow Cytometry Resource Specialist
+        Date: Jan 2018 - Mar 2019
+        Details:
+          - Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat
+          - Nisl tincidunt eget nullam non nisi est
+          - Sed viverra tellus in hac.
+          - Lorem ipsum dolor sit amet, consectetur adipiscing elit
+        Badges: ['Python', 'HTML', 'CSS', 'C#/Unity']
+  - Employer: Institute of Neural Engineering
+    Place: Graz, AT
+    Positions:
+      - Title: Master's Thesis Research Intern
+        Date: Oct 2016 - Jun 2017
+        Details:
+          - Arcu vitae elementum curabitur vitae nunc sed velit
+          - Viverra aliquet eget sit amet tellus cras adipiscing
+          - Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat
+          - Nisl tincidunt eget nullam non nisi est
+        Badges: ['Python', 'MATLAB', 'Data Processing', 'Paradigm Design']
+
+Education:
+  - Course: BSc & MSc in Biomedical Engineering and Biophysics
+    Place: University of Lisbon
+    Date: Sep 2012 - Nov 2017
+    Details: Specialised in data analysis
+
+Skills:
+  - Family: Programming
+    Items:
+      - Python
+      - HTML (including Jinja)
+      - Javascript
+      - CSS
+      - SASS
+      - SQL
+      - C#
+      - Bash
+      - MATLAB
+  - Family: Frameworks
+    Items:
+      - Django
+      - Flask
+      - Hugo
+      - React
+  - Family: Developer Tools
+    Items:
+      - Git
+      - Docker
+      - Jenkins
+      - AWS
+  - Family: Misc
+    Items:
+      - Adobe Tools
+      - LaTeX
+
+Languages:
+  - Name: Portuguese
+    Level: Native
+  - Name: English
+    Level: C2
+  - Name: Spanish
+    Level: B1
+  - Name: German
+    Level: B1
+
+Diplomas:
+  - ISTQB Tester Certification (2019)
+  - English Cambridge CAE (2009)
+
+Interests:
+  - Bouldering
+  - Cooking
+  - Windsurfing
+  - Bossa Nova
+  - Design
+  - Languages
diff --git a/exampleSite/static/img/avatar.jpg b/exampleSite/static/img/avatar.jpg
new file mode 100644
index 0000000..b2677e0
--- /dev/null
+++ b/exampleSite/static/img/avatar.jpg
diff --git a/images/screenshot.png b/images/screenshot.png
new file mode 100644
index 0000000..b292700
--- /dev/null
+++ b/images/screenshot.png
diff --git a/images/screenshot_color.png b/images/screenshot_color.png
new file mode 100644
index 0000000..a76e120
--- /dev/null
+++ b/images/screenshot_color.png
diff --git a/images/screenshot_full.png b/images/screenshot_full.png
new file mode 100644
index 0000000..0dd07b8
--- /dev/null
+++ b/images/screenshot_full.png