Release v0.0.1

- Add basic structures
2021-09-09 14:40:48 +09:00
parent a8a7cb7307
commit dbfae56864
18 changed files with 680 additions and 1 deletions
--- a/.gitattributes
+++ b/.gitattributes
@@ -0,0 +1,16 @@
+*.sh            eol=lf
+*.ac            eol=lf
+*.am            eol=lf
+*.dsw           eol=crlf
+*.dsp           eol=crlf whitespace=space-before-tab
+*.sln           eol=crlf
+*.vcproj        eol=crlf
+*.vcxproj*      eol=crlf
+.gitattributes  export-ignore
+.gitignore      export-ignore
+INSTALL_WIN.txt eol=crlf
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.dll filter=lfs diff=lfs merge=lfs -text
+*.exe filter=lfs diff=lfs merge=lfs -text
+*.lib filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1,220 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# Visual Studio 2015 Git issues
+*.VC.opendb
+*.VC.db
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+[Bb]in/
+[Oo]bj/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# DNX
+project.lock.json
+artifacts/
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# TODO: Comment the next line if you want to checkin your web deploy settings 
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+
+# Windows Azure Build Output
+csx/
+*.build.csdef
+
+# Windows Store app package directory
+AppPackages/
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.pfx
+*.publishsettings
+node_modules/
+orleans.codegen.cs
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
--- a/.gitlab-ci.yml.SAMPLE-1
+++ b/.gitlab-ci.yml.SAMPLE-1
--- a/.gitlab-ci.yml.SAMPLE-2
+++ b/.gitlab-ci.yml.SAMPLE-2
@@ -0,0 +1,110 @@
+# Sample .gitlab-ci.yml
+
+workflow:
+  rules:
+    - if: $CI_COMMIT_REF_NAME =~ /-wip$/
+      when: never
+    - if: $CI_COMMIT_TAG  # Execute jobs when new commit with tag
+      when: always
+    - if: $CI_COMMIT_MESSAGE =~ /\[skip[ _-]tests?\]/i # don't execute when commit message with "[skip_tests]"
+      when: never
+  #  - if: $CI_MERGE_REQUEST_ID               # Execute jobs in merge request context
+    - if: $CI_COMMIT_BRANCH == 'master'  # Execute jobs when a new commit is pushed to master branch
+      when: always
+    - if: $CI_COMMIT_BRANCH == 'develop'  # Execute jobs when a new commit is pushed to develop branch
+      when: always
+    - if: $CI_COMMIT_BRANCH == 'develop_nuk'  # Execute jobs when a new commit is pushed to 'develop_nuk' branch
+      when: always
+
+stages:
+  - check_requirements
+  - build
+  - cleanup_build
+  - test
+  - packaging
+  - deploy
+  - cleanup
+
+check_requirements_job:
+  stage: check_requirements
+  script:
+    - echo Checking required stuffs...
+  allow_failure: true
+
+build_job:
+  stage: build
+  #rules:
+  #  - exists: 
+  #    - ..\ExternalLibs_v2/VERSION
+  script:
+  #  - make build
+    - echo Building...
+  when: on_success # Execute when 'check_requirements_job' was succeeded
+
+cleanup_build_job:
+  stage: cleanup_build
+  script:
+  #  - cleanup build when failed
+    - echo Cleanup building...
+  when: on_failure # Execute when 'build_job' was failed
+
+test_job:
+  stage: test
+  script:
+  #  - make test
+    - echo Testing...
+  ## Execute when only commits tagged on 'develop' branch
+  only:
+    refs:
+      - tags
+      - develop
+      - develop_nuk
+  #except:
+  #  - /^(?!develop).+$/
+
+packaging_job:
+  stage: packaging
+  script:
+  #  - echo Packaging...
+    - echo "Packaging and Release to Production"
+  ## Execute when only commits tagged on 'master' branch
+  only:
+    refs:
+      - tags
+      - master
+    #variables:
+    #  - $CI_COMMIT_TAG =~ /^v[0-9]{8}.[0-9]{4}_dev$/
+  #except:
+  #  - /^(?!master).+$/
+
+
+deploy_job:
+  stage: deploy
+  script:
+  #  - make deploy
+    - echo Deploying...
+  when: manual
+  ## Execute when only commits tagged on 'master' branch
+  only:
+    refs:
+      - tags
+      - master
+  #except:
+  #  - /^(?!master).+$/
+
+cleanup_job:
+  stage: cleanup
+  script:
+  #  - cleanup after jobs
+    - echo Cleanup after jobs
+  when: always
+
+#--------------------------
+## check_before_build:
+##   stage: test
+##   script:
+##     - echo Checking requirements
+##   # run PowerShell Command
+##   # — powershell -Command “Get-Date”
+##   # run PowerShell script
+##   # — powershell -File copyFiles.ps1
--- a/.gitlab/.gitkeep
+++ b/.gitlab/.gitkeep
--- a/.gitlab/issue_templates/.gitkeep
+++ b/.gitlab/issue_templates/.gitkeep
--- a/.gitlab/issue_templates/Bug.md
+++ b/.gitlab/issue_templates/Bug.md
@@ -0,0 +1,79 @@
+### Defect / Bug (결함 혹은 버그)
+>>> 
+Summarize this **Defect** or **Bug** encountered concisely
+
+결함 혹은 버그의 내용을 요약해 주세요
+>>>
+
+- Summary 1
+- Summary 2
+
+----
+
+### Steps to reproduce (재현방법)
+>>>
+Important: How can we reproduce this **Defect** or **Bug**
+
+중요함: 재현이 가능하다면 그 방법/절차는 어떻게 되는지 상세히 설명해 주세요
+>>>
+
+1.  Step 1
+2.  Step 2
+
+----
+
+### What is the current bug/issue behavior? (현재 나타난 문제점)
+>>>
+What actually happens
+
+현재 어떤 문제가 발생했는지 상세히 설명해 주세요
+>>>
+
+- Problem 1
+- Problem 2
+
+----
+
+### What is the expected correct behavior? (정상적인 경우)
+>>>
+What you should see instead
+
+정상적인 경우라면 어떤 결과가 나와야 하는지 설명해 주세요
+>>>
+
+- Expected 1
+- Expected 2
+
+----
+
+### Relevant logs and/or screenshots (관련 로그/에러메시지 또는 스크린샷)
+>>>
+Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's very hard to read otherwise.
+
+로그, 에러메시지 또는 스크린샷을 첨부해 주세요
+>>>
+
+- Item 1
+- Item 2
+
+----
+
+### Possible fixes (해결 방안 제안)
+>>>
+If you can, link to the line of code that might be responsible for the problem
+
+제안할 수 있는 해결방안이 있다면 간략히 설명하거나, 참조할 수 있는 코드 링크를 제시해 주세요
+>>>
+
+- Suggest 1
+- Suggest 2
+
+
+
+----
+> 아래 내용 지우지 마세요 (DO NOT DELETE BELOW LINES)
+
+/label ~"defect::Minor"
+
+/cc @nukbridge
--- a/.gitlab/issue_templates/Meeting_Minutes.md
+++ b/.gitlab/issue_templates/Meeting_Minutes.md
@@ -0,0 +1,95 @@
+## Meeting Information (회의 정보)
+>>>
+Describe meeting information
+
+회의에 관한 기본 정보를 요약해 주세요
+>>>
+
+- Date(날짜):
+- Time(시간):
+- Location(장소):
+
+### Meeting Objective (회의의 목적)
+>>>
+Summarize main objective of this meeting minutes
+
+회의의 목적에 대해서 간략히 설명하세요
+>>>
+
+- Goal 1
+- Goal 2
+
+### Attendees (참석자)
+>>>
+Describe attendees information
+
+참석자들의 정보를 기입해 주세요
+>>>
+
+- Name 1 (Dept./Division, Email, Phone)
+- Name 2 (Dept./Division, Email, Phone)
+
+### Meeting Agenda (회의 안건)
+>>>
+Describe topics with proposer name
+
+토론해야 될 각 안건에 대해 요약해 주세요
+>>>
+
+- Topic 1 (Owner)
+- Topic 2 (Owner)
+
+### Preparation (준비사항)
+>>>
+Documents/Handouts to bring, reading material, etc.
+
+준비물 리스트를 나열해 주세요
+>>>
+
+- Item 1 (Prepared by Name)
+- Item 2 (Prepared by Name)
+
+----
+
+## Discussed (토론 내용)
+### Agenda and Notes, Decisions, Issues (안건, 노트, 결정사항, 이슈)
+>>>
+Summarize discussed things in this meeting minutes
+
+이번 회의에서 토의된 내용들을 요약해 주세요
+>>>
+
+- Topic 1 (Owner)
+- Topic 2 (Owner)
+
+### Action Items (결정된 내용)
+>>>
+Summarize actions decided to do
+
+회의에서 결정된 사항들을 나열해 주세요
+>>>
+
+- Action 1 (Owner, Due Date)
+- Action 2 (Owner, Due Date)
+
+### Next Meeting (다음 회의 일정)
+>>>
+If applicable, just summarize here
+
+다음 회의가 예정되어 있다면 해당 정보를 요약하세요
+>>>
+
+- Date (MM/DD/YYYY):
+- Time:
+- Location:
+- Objective:
+
+
+
+
+----
+> 아래 내용 지우지 마세요 (DO NOT DELETE BELOW LINES)
+
+/label ~"Meeting Minutes"
+
+/cc @nukbridge
--- a/.gitlab/issue_templates/Report.md
+++ b/.gitlab/issue_templates/Report.md
@@ -0,0 +1,61 @@
+<!-- Instructions: Use this template for a technical/general report or review. Please follow the instructions below accordingly. --> 
+
+### Topic to Report/Review
+>>>
+Describe topic and related issue
+>>>
+
+**Making Awesome Thing** (~2021.09.15)
+
+- [Link to other Issue](link)
+
+----
+
+### Tasks Planned/Done (Weekly/Monthly/Yearly)
+>>>
+Outline the tasks that you need to report or required to review
+>>>
+
+- [x] Task was scheduled and done (~2021.09.09)
+- [ ] Task was scheduled but not done (~2021.09.10)
+- ~~[ ] Task was planned but removed (~2021.09.08)~~
+
+----
+
+### Changes
+>>>
+Describe what were changed from Planned Tasks
+>>>
+
+- Things that changed
+- Things that improved
+- Things that researched
+
+----
+
+### Next Steps (on Next Week/Month/Year)
+>>>
+Describe what will be in next step
+>>>
+
+- Things in next step 1 (~2021.09.20)
+- Things in next step 2 (~2021.09.21)
+
+----
+
+### Risks / Considerations
+>>>
+Identify any risks found in the research, whether this is performance, impacts to other functionality or other bugs
+>>>
+
+- Risk 1
+- Risk 2
+- Consideration 1
+- Consideration 2
+
+
+----
+> DO-NOT-DELETE-BELOW-LINES
+
+/label ~"type::Reporting"
+/cc @nukbridge
--- a/.gitlab/issue_templates/To_Do.md
+++ b/.gitlab/issue_templates/To_Do.md
@@ -0,0 +1,34 @@
+### To Do (해야 할 일)
+>>>
+Describe this **To Do** issue here using short phrases.
+
+여기에 간단한 문장으로 **To Do** 내용을 설명하세요.
+>>>
+
+1. [ ] Task To Do 1
+    1.  [ ] Sub-task 1
+    2.  [ ] Sub-task 2
+2. [ ] Task To Do 2
+    1.  [ ] Sub-task 1
+    2.  [ ] Sub-task 2
+
+----
+
+### Refs. Links (참조)
+>>>
+Add external links or attached documents
+
+외부 참조 링크 또는 첨부된 문서 링크
+>>>
+
+- e.g 1) [위키 홈](http://git.doubleme.me/task-manage/team-studio/-/wikis/home)
+- e.g 2) [I'm an inline-style link](https://www.google.com)
+
+
+
+----
+> 아래 내용 지우지 마세요 (DO NOT DELETE BELOW LINES)
+
+/label ~"status::To Do"
+
+/cc @nukbridge
--- a/.gitlab/issue_templates/User_Story.md
+++ b/.gitlab/issue_templates/User_Story.md
@@ -0,0 +1,47 @@
+### User Story (사용자 스토리)
+>>>
+Describe this **User Story** here based on `Role`, `Action`and `Reason`
+
+**User Story** 에 대해 설명하세요. `역할`, `행동`, `이유` 가 명확하게 드러나야 합니다.
+>>>
+
+- e.g 1) User want to see *preview* in *reconstruction* stage because he/she want to check *current* input frame from camera device (사용자는 *reconstruction* 진행 중에 *preview* 화면을 보기를 원한다. 왜냐하면 카메라에서 입력되는 현재 프레임을 확인하고 싶기 때문이다)
+
+#### Tasks To Do (해야 할 일)
+-  [ ] e.g 1) *preview* 영역 구현
+-  [ ] e.g 2) *preview* 영역 켜기/끄기 기능 구현
+-  [ ] e.g 3) 단위테스트
+-  [ ] e.g 4) 전체 시스템에 미치는 오류가 없는지 검증
+
+----
+
+### Acceptable Condition (수용 기준)
+>>>
+Describe conditions based on SMART(Specific, Measurable, Achievable, Realistic, Testable)
+
+스토리 완료를 위한 수용기준을 구체적으로 제시하세요. 측정가능해야 하고, 달성 가능해야 하고, 현실적이어야 하며 테스트가 가능해야 합니다.
+>>>
+
+- e.g 1) 기능: *reconstruction* 이 시작되면 화면 왼쪽하단 *preview* 영역에 카메라에서 입력되는 현재 프레임이 표시됨
+- e.g 2) 성능: *preview* 영역에 표시되는 프레임과 실제 *reconstruction* 진행중인 프레임 간의 표현시 지연시간은 1ms 를 넘지 않아야 한다. TestCase_001로 지연시간 측정
+- e.g 3) 테스트: TestCase_001, TestCase_002
+
+----
+
+### Dependencies (스토리간 의존성)
+>>>
+Describe or add related *User Story* or *Issue*
+
+관련된 *User Story* 혹은 *Issue* 를 설명하거나 링크를 추가하세요.
+>>>
+
+- e.g 1) 사용자용 UI 화면구성 스토리
+- e.g 2) Gitlab의 *Linked Issue* 기능을 활용해 관련된 스토리들을 묶어 주세요
+
+
+----
+> 아래 내용 지우지 마세요 (DO NOT DELETE BELOW LINES)
+
+/label ~"story::User"
+
+/cc @nukbridge
--- a/1
+++ b/1
@@ -0,0 +1 @@
+# Authors
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -0,0 +1 @@
+# Install
--- a/1
+++ b/1
@@ -0,0 +1 @@
+# Notice
--- a/PROJECT_FILES/.gitkeep
+++ b/PROJECT_FILES/.gitkeep
--- a/PROJECT_FILES/READ_AND_REMOVE.md
+++ b/PROJECT_FILES/READ_AND_REMOVE.md
@@ -0,0 +1,3 @@
+# READ then REMOVE THIS FILE
+
+After prepared all project files such as source code, you can remove this file
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
 # SAMPLE Project

-Sample Project for Gitlab specific functionalities
+Sample Project for Gitlab specific functionalities
+
+**PLEASE REPLACE ALL CONTENTS IN THIS FILE AS YOUR OWN**
+
+## Applying your own sources/docs
+
+- Place all your conducted sources, docs under 'PROJECT_FILES'
+- Rename 'PROJECT_FILES' directory as you want.
+- You can change any files under this root directory, except '.git', '.gitlab' directory.
+- If you want to officially represented versioned control of this source tree, then use 'VERSION' file.
+- If you want to use CI/CD functionalities, just refer to '.gitlab-ci.yml.SAMPLE-1' and '.gitlab-ci.yml.SAMPLE-2' or make your own CI/CD configuration file.
--- a/1
+++ b/1
@@ -0,0 +1 @@
+0.0.1