diff options
| author | Roger Gonzalez <roger@rogs.me> | 2023-01-10 20:49:43 -0300 |
|---|---|---|
| committer | Roger Gonzalez <roger@rogs.me> | 2023-01-10 20:49:43 -0300 |
| commit | 8b567d233fa092113f51414ee871d6a92716c859 (patch) | |
| tree | e7ef78810144d45a981e9fd773303e31aa723677 | |
| parent | e6213e5424dbd7e5461a0907fc0857a784ad0753 (diff) | |
Added README
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..72354b6 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +yams.media +========== + +This are the source files for https://yams.media. + +## Dependencies + +- hugo. +- cwebp (development only). + +## To run + +### For development + +``` sh +git clone git@gitlab.com:rogs/yams.media.git +cd yams.media +ln -s $(pwd)/pre-commit $(pwd)/.git/hooks # for pre-commit hooks +hugo serve +``` +And open http://localhost:1313 to see the site. + +#### About the pre-commit hooks and MacOS + +If you are in MacOS you might have problems because of the `sed` command. If you are having problems, just change `sed -i` for `sed -i ''` and you'll be good to go! Please do not commit this change into the repository. + +### For production + +``` sh +git clone git@gitlab.com:rogs/yams.media.git +cd yams.media +hugo +``` + +Your files will be on the ``./public` folder, ready to upload to a server. |