From 28ab0dd9809c6367fc58898c4060056d588077fc Mon Sep 17 00:00:00 2001 From: Jimmy Cai Date: Fri, 9 Jul 2021 13:04:30 +0200 Subject: [PATCH] doc: update README to include license information --- README.md | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 14079f1..c1157a2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Netlify Status](https://api.netlify.com/api/v1/badges/a2d2807a-a905-4bcb-97da-8da8d847da3d/deploy-status)](https://app.netlify.com/sites/hugo-theme-stack/deploys) -## Documentation & more information +## Documentation [Documentation](https://docs.stack.jimmycai.com/) | [中文文档](https://docs.stack.jimmycai.com/zh/) @@ -31,18 +31,13 @@ Stack is a simple card-style Hugo theme designed for bloggers, some of its featu ## Requirements -It's necessary to use **Hugo ≥ 0.78.0**. - -Use Hugo Extended version (recommended) if you want to: - -* Use the latest feature/fix from `master` branch -* Edit SCSS files - -**Compiled CSS are updated once per release.** +It's necessary to use **Hugo Extended ≥ 0.78.0**. ## Installation -Clone / Download this repository to `theme` folder, and edit your site config following `exampleSite/config.toml`. +Clone / Download this repository to `theme` folder, and edit your site config following `exampleSite/config.yaml`. + +*Note: Remove `config.toml` if there is one in the site folder.* Check [documentation](https://docs.stack.jimmycai.com/) for more details. @@ -64,13 +59,22 @@ Your support is greatly appreciated :) ## Thanks to - - [Vibrant-Colors/node-vibrant](https://github.com/Vibrant-Colors/node-vibrant) - - [Normalize.css](https://necolas.github.io/normalize.css/) - - [Tabler icons](https://tablericons.com/) - - [Pure CSS implementation of Google Photos / 500px image layout](https://github.com/xieranmaya/blog/issues/6) - - [jonsuh/hamburgers](https://github.com/jonsuh/hamburgers) - - [PhotoSwipe](https://photoswipe.com/) - - [artchen/hexo-theme-element](https://github.com/artchen/hexo-theme-element) - - [MunifTanjim/minimo](https://github.com/MunifTanjim/minimo) - - [lepture/yue.css](https://github.com/lepture/yue.css) - - Markdown gallery syntax from [Typlog](https://typlog.com/) +| Project | Description | Licence | +| ------- | ----------- | ------- | +| [PhotoSwipe](https://photoswipe.com/) | For the lightbox effect | [MIT](https://github.com/dimsemenov/PhotoSwipe/blob/master/LICENSE) | +| [Normalize.css](https://github.com/necolas/normalize.css) | - | [MIT](https://github.com/necolas/normalize.css/blob/master/LICENSE.md) | +| [Node Vibrant](https://github.com/Vibrant-Colors/node-vibrant) | To extract the color from images | [MIT](https://github.com/Vibrant-Colors/node-vibrant/blob/master/LICENSE.md) +| [Tabler icons](https://github.com/tabler/tabler-icons) | Default menu icons | [MIT](https://github.com/tabler/tabler-icons/blob/master/LICENSE) | +| [jonsuh/hamburgers](https://github.com/jonsuh/hamburgers) | Hamburger icon of menu | [MIT](https://github.com/jonsuh/hamburgers/blob/master/LICENSE) | +| [lepture/yue.css](https://github.com/lepture/yue.css) | Part of it is used for styling article content | MIT | +| [Typlog](https://typlog.com/) | Where the markdown gallery syntax is borrowed from | The author gave me the permission | +| [Pure CSS implementation of Google Photos / 500px image layout](https://github.com/xieranmaya/blog/issues/6) | Used for image gallery | - | + +### References + +Some references that I took while building this theme: + +| Project | Licence| +| ------- | ------| +| [artchen/hexo-theme-element](https://github.com/artchen/hexo-theme-element) | [MIT](https://github.com/artchen/hexo-theme-element/blob/master/LICENSE) | +| [MunifTanjim/minimo](https://github.com/MunifTanjim/minimo) | [MIT](https://github.com/MunifTanjim/minimo/blob/master/LICENSE) | \ No newline at end of file