Update README

This commit is contained in:
Giuseppe Masino 2022-03-19 00:23:24 +01:00
parent 73c61a0614
commit 4823ad8a77
2 changed files with 34 additions and 35 deletions

34
README.adoc Normal file
View File

@ -0,0 +1,34 @@
[pass]
--
<center>
<h1> Simple Intro </h1>
<p>
A simple theme for hugo. <br/>
Based on the original work of
<a href="https://github.com/gangjun06/SimpleIntro">gangjun06</a>.
</p>
<img src="images/screenshot.png" />
</center>
--
== Get Started
[literal]
--
hugo new site <site-name>
cd <site-name>
git submodule add https://github.com/qub1750ul/hugo-simpleIntro themes/simpleIntro
--
== Development
Switch to the `exampleSite` branch for info on the development workflow.
== Credits
|===
| Name | License | Description
| github.com/gangjun06/SimpleIntro | Apache | Original work
| github.com/konpa/devicon/ | MIT License | Demo Site Icon
| github.com/tailwindlabs/tailwindcss | MIT License | Css Library
|===

View File

@ -1,35 +0,0 @@
Sorry for not managing properly. I hope this repo helped you create a hugo theme
# Simple Intro
simple theme for hugo
![intro](https://raw.githubusercontent.com/gangjun06/SimpleIntro/master/images/screenshot.png)
# Live Demo
https://gangjun06.github.io/SimpleIntroDemo
# Get Started
```bash
hugo new site <site-name>
cd <site-name>
git submodule add https://github.com/gangjun06/SimpleIntro themes/SimpleIntro
```
# Configuration
Check out the config files included on the [exampleSite](exampleSite)
# Credits
| Name | License | Description |
| ----------------------------------- | ----------- | -------------- |
| github.com/konpa/devicon/ | MIT License | Demo Site Icon |
| github.com/tailwindlabs/tailwindcss | MIT License | Css Library |
# ETC.
It seems that I made this project and neglected it too much.
So I am modifying the code little by little in the new branch