From e21604434a955ab7937f0520a0a90aee733249c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?O=CC=81scar=20M=2E=20Lage?= Date: Thu, 30 Dec 2021 19:35:04 +0100 Subject: [PATCH] Fix: Add some more information to the README file --- README | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README b/README index 92ffdc3..2a32909 100644 --- a/README +++ b/README @@ -1 +1,37 @@ -# Web oscarmlage.com +# oscarmlage.com + +## Instructions + +After `git clone` you can run this site with a simple `make serve`: + +```sh +$ make serve +[...] +Attaching to serve_1 +serve_1 | Start building sites … +serve_1 | hugo v0.88.0-ACC5EB5B linux/amd64 BuildDate=2021-09-02T09:27:28Z VendorInfo=gohugoio +serve_1 | +serve_1 | | EN +serve_1 | -------------------+----- +serve_1 | Pages | 34 +serve_1 | Paginator pages | 0 +serve_1 | Non-page files | 3 +serve_1 | Static files | 19 +serve_1 | Processed images | 0 +serve_1 | Aliases | 14 +serve_1 | Sitemaps | 1 +serve_1 | Cleaned | 0 +serve_1 | +serve_1 | Built in 293 ms +``` + +Then the site will be available in `http://localhost:1313` + +## Other commands + +- `make build`: Builds the static site into `public/` directory +- `make shell`: Enters in the container in order to create new contents, etc.... + Once inside the container you can run some other `hugo` commands: + - `hugo new posts/slugified-title`: Create a new post. + - `hugo new projects/whatever`: Create a new project called `whatever`. +