aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-06-21 05:04:45 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-06-21 05:04:45 +0300
commit37d6dc2cc28a26306651ba1a9251fa1a8161633e (patch)
tree3c1a07191c742d813df46596da79681d732efc34 /README.md
parentfix links & code style (diff)
downloadblog-37d6dc2cc28a26306651ba1a9251fa1a8161633e.tar.gz
blog-37d6dc2cc28a26306651ba1a9251fa1a8161633e.zip
put most of my personal info to _config.yml
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 17 insertions, 12 deletions
diff --git a/README.md b/README.md
index 88a6746..8b9e2fb 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
-# C++ notes
+C++ notes
+=========
Personal C++ notes.
Hosted using [GitHub Pages] at https://egor-tensin.github.io/cpp-notes/.
[GitHub Pages]: https://pages.github.com
-## Installation
+Installation
+------------
[Jekyll] is used to build a set of static HTML pages from a collection of
templates and resources.
@@ -25,7 +27,8 @@ in the project's root directory.
[Jekyll]: https://jekyllrb.com/
[Bundler]: http://bundler.io/
-## Development
+Development
+-----------
To run a local web server, execute
@@ -46,23 +49,25 @@ from `_config.yml` during development.
In particular, it
* sets `minified_externals` to `false` so that the properly formatted versions
- of external CSS stylesheets and JavaScript files are included instead of the
- `min`ified versions,
+of external CSS stylesheets and JavaScript files are included instead of the
+`min`ified versions,
* sets `include_comments` to `false` to exclude the Disqus comments section
- from the posts,
+from the posts,
* sets `baseurl` to an empty string so that the website can be accessed from
- local web server's root directory (i.e. from http://localhost:4000/ instead
- of http://localhost:4000/cpp-notes/).
+local web server's root directory (i.e. from http://localhost:4000/ instead of
+http://localhost:4000/cpp-notes/).
-## Accessing via file://
+Accessing via file://
+---------------------
Jekyll doesn't provide native support for generating a static website which can
-be viewed without a web server.
-One easy workaround might be to `wget` the website and convert the links:
+be browsed without running an instance of Jekyll's web server.
+One easy workaround is to `wget` the website and convert the links:
wget --convert-links --recursive http://localhost:4000/
-## License
+License
+-------
This project, including all of the files and their contents, is licensed under
the terms of the MIT License.