Create README.md

This commit is contained in:
Anthony Wang 2021-07-14 17:55:45 +00:00 committed by GitHub
parent d2185fc427
commit c42a062823
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

27
README.md Normal file
View file

@ -0,0 +1,27 @@
# HOWTuwu
Your guide to everything!
## Contributing
First, clone this repository and theme
```
git clone https://github.com/Ta180m/HOWTuwu.git
cd HOWTuwu
git submodule init
git submodule update --remote
```
Now build the theme
```
cd themes/hug-geekdoc
npm install
npx gulp default
```
After this is all done, you can run the site from the root directory with
```
hugo server
```
## Logo
Original image from [Reddit](https://www.reddit.com/r/linuxmasterrace/comments/lxfg9j/someone_posted_uwuntu_so_i_made_nyarch/). Transparent version generated using the legendary ImageMagick with
```
convert logo.png -alpha off -bordercolor white -border 1 \( +clone -fuzz 10% -fill none -floodfill +0+0 white -floodfill +163+776 white -floodfill +522+661 white -floodfill +829+774 white -floodfill +910+734 white -alpha extract -geometry 200% -blur 0x0.5 -morphology erode square:1 -geometry 50% \) -compose CopyOpacity -composite -shave 1 logo-transparent.png
```