diff options
| author | Alexandre Negrel <negrel.dev@protonmail.com> | 2020-07-12 13:39:46 +0300 |
|---|---|---|
| committer | Alexandre Negrel <negrel.dev@protonmail.com> | 2020-07-12 13:39:46 +0300 |
| commit | 894e15df67c3ab1a9041bd781bb8c3cd23a8a312 (patch) | |
| tree | bdd1311ec22d6fbbd428792f998b1649ff47069f /README.md | |
| parent | dd7a65fa6749c4164ce1fa6ace47abd8f0ac63ed (diff) | |
updating readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 40 insertions, 4 deletions
@@ -1,6 +1,6 @@ # :black_circle: Pico <p> - <a href="https://app.netlify.com/sites/spongebob-pico/deploys"> + <a href="https://app.netlify.com/sites/sponge-bob/deploys"> <img alt="Netlify Status" src="https://api.netlify.com/api/v1/badges/934b7c29-32b9-4ed5-92e7-79cfba9a27b7/deploy-status"> </a> <a href="https://github.com/negrel/ginger/raw/master/LICENSE"> @@ -8,13 +8,49 @@ </a> </p> -This theme aims to be minimalist, readable, responsive , light and beautiful. Inspired by **Medium** and **The New York Times**, Pico try to provide the best experience for the reader while having an awesome design. It can be configured as a single page, or as a full-featured site with multiple sections. It is multilingual, responsive, and includes a light and *dark theme* (*soon*). +This theme aims to be minimalist, readable, responsive, light and beautiful. Inspired by **Medium** and **The New York Times**, Pico try to provide the best experience for the reader while having an awesome design. It can be configured as a single page, or as a full-featured site with multiple sections. It is multilingual, responsive, and includes a light and *dark theme* (*soon*). + +## Preview the theme +Pico ships with an fully configured example site. For a quick preview: + +``` +cd themes/pico/exampleSite/ +hugo server --themesDir ../.. +``` + +Then visit `http://localhost:1313/` in your browser to view the example site. + +## Getting started + +### Requirements +- Extended version of [Hugo](https://gohugo.io/getting-started/installing/) (latest version recommended) +Some [NPM](https://npmjs.org) packages : +- [postcss-cli](https://www.npmjs.com/package/postcss-cli) +- [postcss-import](https://www.npmjs.com/package/postcss-import) +- [autoprefixer](https://www.npmjs.com/package/autoprefixer) +- [@fullhuman/postcss-purgecss](https://www.npmjs.com/package/@fullhuman/postcss-purgecss) +- [tailwindcss](https://www.npmjs.com/package/tailwindcss) https://tailwindcss.com/ + +Learn how to install and use npm [here](https://www.npmjs.com/get-npm). + +### Get the theme + +``` +# Create the base file for our static site +hugo new site your_site_name + +cd your_site_name + +# Get the theme +git clone https://github.com/negrel/pico-hugo-theme themes/pico +``` + ### Contributing -If you want to contribute to Ginger to add a feature or improve the code contact me at [negrel.dev@protonmail.com](mailto:negrel.dev@protonmail.com), open an [issue](https://github.com/negrel/pico-hugo-theme/issues) or make a [pull request](https://github.com/negrel/pico-hugo-theme/pulls). +If you want to contribute to Pico to add a feature or improve the code contact me at [negrel.dev@protonmail.com](mailto:negrel.dev@protonmail.com), open an [issue](https://github.com/negrel/pico-hugo-theme/issues) or make a [pull request](https://github.com/negrel/pico-hugo-theme/pulls). ## :stars: Show your support Please give a :star: if this project helped you! #### :scroll: License -MIT © Alexandre Negrel
\ No newline at end of file +MIT © [Alexandre Negrel](https://www.negrel.dev)
\ No newline at end of file |