From a5c34c55c9ebf1f1c6b555d6c9187f396bab23b7 Mon Sep 17 00:00:00 2001 From: Naoki Rinmous Date: Tue, 16 Jan 2018 03:50:38 +0800 Subject: [PATCH] fix #1: add readme for project setup --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a2bbb1f --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# ~/amphineko + +This repository is a development copy of my homepage ([https://futa.moe/amphineko/](https://futa.moe/amphineko/)), which can be used as a template. + +Text contents are mainly located at `index.html`. To replace the texts and the picture (`amphineko.png`), can be easily done by editing this file. + +For futuremore modification, including color settings and layouts, check SASS files in `assets/stylesheets`. Don't forget `gulp`-ing to rebuild SASS files and reflect your modification. + +## build + +To build this repository, run these following commands: + +``` +npm install . +npm run build +``` + +You may check your `NODE_ENV` before executing `npm install .` to ensure `devDependencies` are installed. + +`install` might be pretty hard for Windows users who have poor connections to GitHub (for some well-known reasons), while `npm` is trying to fetch `node-sass-binaries` on GitHub.