diff --git a/Mockup.png b/Mockup.png new file mode 100644 index 0000000..b491673 Binary files /dev/null and b/Mockup.png differ diff --git a/Mockup.xcf b/Mockup.xcf new file mode 100644 index 0000000..8e7d02e Binary files /dev/null and b/Mockup.xcf differ diff --git a/README.md b/README.md index aff53c8..fb66633 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,26 @@ # BootstrapHomepageTemplate -A simple Bootstrap theme template for an academic webpage, themed with IIT -Dharwad colours and typography. +A simple Bootstrap theme template for an academic webpage, themed with IIT Dharwad colours and typography. Bootstrap is a simple Javascript Library that enables lightweight yet responsive pages that look and feel great on all devices, from small mobile phones to tablets to large desktop displays. -To edit, I recomment the open-source editor "Brackets" which has a "live-preview" mode, showing the changes as the HTML code is modified. +#### Appearance +This is what the template looks like on desktop and mobile: +![A mockup showing appearance on desktop and mobile](Mockup.png "Mockup Appearance") -NOTE: Since IITDH uses a self-signed certificate, you may need to use the following command to clone this repo: +#### Usage +###### Download +Essentially you need to download the code, edit, and copy it into the web directory of your webserver. + +To download the code you can click the download button or git-clone the repo. Note that if you are git-cloning over SSH from IITDG-Gitea (which uses a self-signed certificate) you may need to use the following command to clone this repo: +``` git -c http.sslVerify=false clone https://gitea.iitdh.ac.in:443/kabhijit/BootstrapHomepageTemplate.git +``` +###### Modifying +To edit, I recomment the open-source editor "Brackets" which has a "live-preview" mode, showing the changes as the HTML code is modified. Simple changes can be made by just replacing the sample text blocks in the html file (a rudimentary understanding of HTML is sufficient). For more complex changes to the layout a good understanding of bootstrap may be necessary. Colors and themes are defined in the accompanying css file. + + +#### Credits +This template was inspired by and based on the simple and elegant bootstrap template [mavroudisv/plain-academic](https://github.com/mavroudisv/plain-academic) +