aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorValentin Popov <info@valentineus.link>2018-05-16 19:56:35 +0300
committerValentin Popov <info@valentineus.link>2018-05-16 19:56:35 +0300
commitd9f1af38a77a71cec0b1088ea5c08956fae3e477 (patch)
tree114511a7a7381302cd660c60293ada7bdf3f60dc /README.md
parent8064b99780411c04ae3aae9ccc74e867654d9ae9 (diff)
downloadpopov.link-d9f1af38a77a71cec0b1088ea5c08956fae3e477.tar.xz
popov.link-d9f1af38a77a71cec0b1088ea5c08956fae3e477.zip
Description of the repository
Signed-off-by: Valentin Popov <info@valentineus.link>
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..ede0083 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,43 @@
+# Personal site
+
+This is my main site.
+The site publishes articles, useful information and notes.
+Also, the site serves as a hosting of free and personal images.
+
+## Development
+
+To start a local server for development, you need:
+
+1. Clone the source repository:
+
+```bash
+git clone "https://github.com/valentineus/valentineus.github.io.git"
+```
+
+2. Install packages:
+
+```bash
+cd valentineus.github.io && bundle update
+```
+
+3. Start the server:
+
+```bash
+bundle exec jekyll serve --host "${IP}" --port "${PORT}" --trace
+```
+
+Please note in the executable command uses environment variables `IP` and `PORT`.
+
+## License hosted material
+
+<img width="256px" alt="CC BY-NC 3.0 License" src="https://raw.githubusercontent.com/valentineus/valentineus.github.io/master/assets/images/87624cb5-4a8f-4be4-90b6-0ec5b9a90333.png" />
+
+Material on the site is published on the CC BY-NC 3.0 license.
+
+## Source Code License
+
+<img width="256px" alt="MIT License" src="https://raw.githubusercontent.com/valentineus/valentineus.github.io/master/assets/images/7d05cad0-d553-42c7-be1f-7007926ba720.png" />
+
+[MIT](LICENSE.txt).
+Copyright (c)
+[Valentin Popov](https://valentineus.link/).