From fd2fc8ab09d794fc3741b4e4baa0d2036591bae1 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=EB=B0=95=EC=A2=85=ED=98=84/=EB=8F=99=EC=9E=91=EC=A0=9C?= =?utf8?q?=EC=96=B4Lab=28SR=29/Senior=20Engineer/=EC=82=BC=EC=84=B1?= =?utf8?q?=EC=A0=84=EC=9E=90?= Date: Mon, 23 Apr 2018 11:30:45 +0900 Subject: [PATCH] Add 'Getting Started' guide (#109) * Add 'Getting Started' guide This commit adds 'getting_started.md' which will include various guide for newcomers although the current version provides guide on docker-based build only. Signed-off-by: Jonghyun Park * Fix a typo * Fix other typos * Fix a typo (environtment -> environment) --- doc/getting_started.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 doc/getting_started.md diff --git a/doc/getting_started.md b/doc/getting_started.md new file mode 100644 index 0000000..f5834ae --- /dev/null +++ b/doc/getting_started.md @@ -0,0 +1,42 @@ +#### How to build _nncc_ with docker + +_nncc_ provides ``Dockerfile`` in order to make it easy to setup development environment. + +One may build ``nncc`` docker image with the following command: +``` +nncc$ cat Dockerfile | docker build -t nncc - +... +``` + +By default, this ``Dockerfile`` uses "archive.ubuntu.com" which may be quite slow. One may use mirror site via ``UBUNTU_MIRROR`` variable. +For example, one may enable the use of ``kr.archive.ubuntu.com`` via the following command +``` +nncc$ cat Dockerfile | docker build --build-arg UBUNTU_MIRROR="kr.archive.ubuntu.com" -t nncc - +... +``` + +One who works behind proxy should provide proxy configuration via the following command: +``` +nncc$ cat Dockerfile | docker build --build-arg HTTP_PROXY= --build-arg HTTPS_PROXY= -t nncc - +... +``` +One may use simplified command if ``HTTP_PROXY`` and ``HTTPS_PROXY`` environment variables are already set: +``` +nncc$ export +... +declare -x HTTP_PROXY=... +declare -x HTTPS_PROXY=... +... +nncc$ cat Dockerfile | docker build --build-arg HTTP_PROXY --build-arg HTTPS_PROXY -t nncc - +... +``` + +Note that these configurations are orthogonal to each other. One may freely combine these options as follows: +``` +nncc$ cat Dockerfile | docker build --build-arg HTTP_PROXY --build-arg HTTPS_PROXY --build-arg UBUNTU_MIRROR="kr.archive.ubuntu.com" -t nncc - +``` + +One may easily build _nncc_ with the following command once ``nncc`` docker image is built. +``` +nncc$ ./nncc docker-build +``` -- 2.7.4