Skip to content

Commit cc2d828

Browse files
manid2manid2
committed
doc: Update features & add license in README
* Update CV content to use the new CV template.
1 parent a654c65 commit cc2d828

File tree

3 files changed

+139
-49
lines changed

3 files changed

+139
-49
lines changed

‎README.md‎

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,49 @@ Demo example site [manid2.github.io/hugo-xterm][7].
88
Features
99
--------
1010

11-
* Designed for reading and printing text.
11+
### Distinguishing features
12+
13+
* Designed for __reading__ and __printing__ text.
14+
* __Print:__ any page in light theme mode for readability.
15+
* __[CV][10]:__ or resume template to reduce vertical space by using 2 columns
16+
and shortcodes to list the experiences and skills.
17+
* __Slides:__ support using [reveal.js][4] (improvement is WIP).
18+
* __Lists__: separate view and pagination for simple list items and post
19+
entries.
20+
* __GitInfo:__ show the latest git commit short hash and subject message for
21+
each page (requires Hugo GitInfo config enabled).
22+
* __Fonts:__
23+
- __"Roboto Slab (serif)"__ for title (heading) text.
24+
- __"Fira Sans (sans-serif)"__ for normal text.
25+
- __"Ubuntu Mono (monospace)"__ for code.
26+
* __Colors:__ in the theme are derived using a single primary color (blue)
27+
from the [HSL colors][8].
28+
* Website banner is supported.
29+
30+
### Adopted features
31+
32+
* Minimal configuration.
1233
* Switchable dark and light themes with automatic selection based on system
1334
theme.
14-
* Uses blue for text, accent and background, green for links.
15-
* Code blocks are highlighted using Hugo built-in blazing fast Chroma.
16-
* Copy code, see code language and file name (optional).
17-
* Slides support using [reveal.js][4] (improvement is WIP).
18-
* Pint any page in light theme mode.
19-
* Support for CV or resume (dedicated layout is WIP).
20-
* Separate view and pagination for list items and post entries.
21-
* Theme can be customized using configurations for: full width, centered.
2235
* SEO friendly OpenGraph and twitter cards support
23-
* Minimal configuration.
36+
* Customizable using configurations for: "full width:, "centered".
2437
* Taxonomies and posts RSS.
25-
* Show git information for site and per single page.
38+
* Responsive tested on desktop and on smart phones.
39+
* Responsive menus for desktop and mobile screens.
40+
* Accessibility tested using [WAVE Web Accessibility Evaluation Tool][5].
41+
* Code blocks are highlighted using Hugo built-in blazing fast [Chroma][9].
42+
* Copy code, see code language and file name (optional).
2643
* Tightly coupled with Hugo extended latest version (v1.110.0) to compile and
2744
generate asset bundles with pipelines, fingerprinting and minification.
28-
* Responsive tested on desktop and on smart phones of 684px.
29-
* Responsive menus for desktop and mobile screens.
30-
* Accessible tested using [WAVE Web Accessibility Evaluation Tool][5].
3145

32-
Other features are supported but not tested yet:
46+
### Other features
47+
48+
These are supported due to [panr/terminal][1] theme base code but not
49+
tested as I don't use them myself:
3350

3451
* Post cover image.
3552
* Images in post with caption.
3653
* Comments.
37-
* Website banner.
3854

3955
Installation
4056
------------
@@ -65,10 +81,19 @@ features from popular themes and websites as listed below:
6581
* [adityatelange/hugo-PaperMod][2] features: breadcrumbs and copy code.
6682
* [kaitlinmctigue/kaitlinmctigue.github.io][3]: dark and light theme modes.
6783

84+
License
85+
-------
86+
87+
[GNU General Public License v3.0][11]
88+
6889
[1]: https://github.com/panr/hugo-theme-terminal
6990
[2]: https://github.com/adityatelange/hugo-PaperMod
7091
[3]: https://github.com/kaitlinmctigue/kaitlinmctigue.github.io
7192
[4]: https://github.com/hakimel/reveal.js
7293
[5]: https://wave.webaim.org/
7394
[6]: https://github.com/adityatelange/hugo-PaperMod/wiki/Installation
7495
[7]: https://manid2.github.io/hugo-xterm/
96+
[8]: https://en.wikipedia.org/wiki/HSL_and_HSV
97+
[9]: https://github.com/alecthomas/chroma/
98+
[10]: https://manid2.gitlab.io/cv/
99+
[11]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE

‎exampleSite/content/about.md‎

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,49 @@ Hugo theme designed for reading and printing text with dark and light modes.
99
Features
1010
--------
1111

12-
* Designed for reading and printing text.
13-
* Switchable dark and light themes, automatic selection based on system theme.
14-
* Uses blue for text, accent and background, green for links.
15-
* Code blocks are highlighted using Hugo built-in blazing fast Chroma.
16-
* Copy code, see code language and file name (optional).
17-
* Slides support using [reveal.js][4] (improvement is WIP).
18-
* Pint any page in light theme mode.
19-
* Support for CV or resume (dedicated layout is WIP).
20-
* Separate view and pagination for list items and post entries.
21-
* Theme can be customized using configurations for: full width, centered.
22-
* SEO friendly OpenGraph and twitter cards support
12+
### Distinguishing features
13+
14+
* Designed for __reading__ and __printing__ text.
15+
* __Print:__ any page in light theme mode for readability.
16+
* __[CV][10]:__ or resume template to reduce vertical space by using 2 columns
17+
and shortcodes to list the experiences and skills.
18+
* __Slides:__ support using [reveal.js][4] (improvement is WIP).
19+
* __Lists__: separate view and pagination for simple list items and post
20+
entries.
21+
* __GitInfo:__ show the latest git commit short hash and subject message for
22+
each page (requires Hugo GitInfo config enabled).
23+
* __Fonts:__
24+
- __"Roboto Slab (serif)"__ for title (heading) text.
25+
- __"Fira Sans (sans-serif)"__ for normal text.
26+
- __"Ubuntu Mono (monospace)"__ for code.
27+
* __Colors:__ in the theme are derived using a single primary color (blue)
28+
from the [HSL colors][8].
29+
* Website banner is supported.
30+
31+
### Adopted features
32+
2333
* Minimal configuration.
34+
* Switchable dark and light themes with automatic selection based on system
35+
theme.
36+
* SEO friendly OpenGraph and twitter cards support
37+
* Customizable using configurations for: "full width:, "centered".
2438
* Taxonomies and posts RSS.
25-
* Show git information for site and per single page.
39+
* Responsive tested on desktop and on smart phones.
40+
* Responsive menus for desktop and mobile screens.
41+
* Accessibility tested using [WAVE Web Accessibility Evaluation Tool][5].
42+
* Code blocks are highlighted using Hugo built-in blazing fast [Chroma][9].
43+
* Copy code, see code language and file name (optional).
2644
* Tightly coupled with Hugo extended latest version (v1.110.0) to compile and
2745
generate asset bundles with pipelines, fingerprinting and minification.
28-
* Responsive tested on desktop and on smart phones of 684px.
29-
* Responsive menus for desktop and mobile screens.
30-
* Accessible tested using [WAVE Web Accessibility Evaluation Tool][5].
3146

32-
Other features are supported but not tested yet:
47+
### Other features
48+
49+
These are supported due to [panr/terminal][1] theme base code but not
50+
tested as I don't use them myself:
3351

3452
* Post cover image.
3553
* Images in post with caption.
3654
* Comments.
37-
* Website banner.
3855

3956
Installation
4057
------------
@@ -65,9 +82,18 @@ features from popular themes and websites as listed below:
6582
* [adityatelange/hugo-PaperMod][2] features: breadcrumbs and copy code.
6683
* [kaitlinmctigue/kaitlinmctigue.github.io][3]: dark and light theme modes.
6784

85+
License
86+
-------
87+
88+
[GNU General Public License v3.0][11]
89+
6890
[1]: https://github.com/panr/hugo-theme-terminal
6991
[2]: https://github.com/adityatelange/hugo-PaperMod
7092
[3]: https://github.com/kaitlinmctigue/kaitlinmctigue.github.io
7193
[4]: https://github.com/hakimel/reveal.js
7294
[5]: https://wave.webaim.org/
7395
[6]: https://github.com/adityatelange/hugo-PaperMod/wiki/Installation
96+
[8]: https://en.wikipedia.org/wiki/HSL_and_HSV
97+
[9]: https://github.com/alecthomas/chroma/
98+
[10]: https://manid2.gitlab.io/cv/
99+
[11]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE

‎exampleSite/content/cv.md‎

Lines changed: 55 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,64 @@
11
+++
2-
title = "hugo-xterm - CV"
2+
title = "CV"
3+
name = "Hugo Xterm"
34
description = """Built using Hugo, Sass and RevealJs."""
4-
date = "2023-07-15"
5-
toc = false
6-
+++
5+
type = "cv"
76

8-
| Contact | Info |
9-
| --- | --- |
10-
| LinkedIn | [linkedin.com/in/manid2/](https://www.linkedin.com/in/manid2/) |
11-
| Github | [github.com/manid2](https://github.com/manid2) |
12-
| Gitlab | [gitlab.com/manid2](https://gitlab.com/manid2) |
13-
| Twitter | [twitter.com/mani_d2](https://twitter.com/mani_d2) |
7+
[contact]
8+
phone = "+91 1234"
9+
email = "your[at]email[dot]com"
10+
+++
1411

15-
EXPERIENCE
12+
Experience
1613
----------
1714

18-
### 2 Aug 2021 – Current
19-
20-
| Designation | Company | Location |
21-
| --- | --- | --- |
22-
| Senior Software Engineer | Sandvine Technologies | Bangalore |
15+
{{< cv/experience
16+
name="Sandvine Technologies"
17+
date="02 Aug 2021 – Present"
18+
title="Senior Software Engineer"
19+
location="Bangalore, India" >}}
2320

2421
* Working as part of Data-Plane team to develop and maintain features for
2522
ActiveLogic product which processes internet packets.
23+
24+
{{< cv/skills
25+
technologies="C, Python, DPDK, NUMA, Data-Plane, TCP/IP, PostgreSQL" >}}
26+
27+
{{< cv/experience
28+
name="Toshiba Software"
29+
date="21 Dec 2016 – 31 Jul 2019"
30+
title="Software Engineer"
31+
location="Bangalore, India" >}}
32+
33+
* Worked in Device Layer development team where I designed & implemented
34+
custom size scan for Toshiba Multi-Functional Peripheral (MFP). With this
35+
feature the users can scan a non-standard paper sizes such as identity
36+
cards, bills and receipts.
37+
38+
{{< cv/skills
39+
technologies="C++, C, JPEG, PDF, OpenCV, Linux, Embedded Systems" >}}
40+
41+
Education
42+
---------
43+
44+
{{< cv/experience
45+
name="BMS College of Engineering"
46+
date="Aug 2012 - Mar 2016"
47+
title=
48+
"Bachelor of Engineering in Electronics and Communications"
49+
location="Bangalore, India" >}}
50+
51+
Technical Skills
52+
----------------
53+
54+
{{< cv/skills
55+
languages="C, C++, Python"
56+
tools="Git, Docker, GDB, Valgrind, Gitlab, Vim, Ctags" >}}
57+
58+
Hobbies
59+
-------
60+
61+
* Hugo theme [manid2/hugo-xterm][1] for my website [manid2.gitlab.io][2].
62+
63+
[1]: https://manid2.github.io/hugo-xterm/
64+
[2]: https://manid2.gitlab.io/

0 commit comments

Comments
 (0)