diff --git a/README.md b/README.md index 963b92c..b856853 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ # working-scala + +## 설명 +working-scala는 2023 오픈소스 컨트리뷰션(OSSCA) `ZIO`에서 생성한 레포지토리입니다. + +각 프로젝트는 하나의 주제에 대한 예시 코드로 구성되어 있습니다. + +## 프로젝트 별 실행방법 + +예제코드의 실행 결과를 보려면 각 프로젝트의 Main Class를 실행해주세요. +경로 : ~/working-scala/ + + ### sbt로 실행 + sbt + project `프로젝트 이름` + run + [스칼라 공식문서 - getting-started](https://docs.scala-lang.org/getting-started/index.html) + + ### inteliJ로 실행 + [jetbrain 공식문서 - run scala app](https://www.jetbrains.com/help/idea/run-debug-and-test-scala.html#run_scala_app) + + +## 컨벤션 +### 프로젝트 이름 +- 영어 소문자로 표기한다. +- 띄어쓰기는 `-`로 표기한다. + +예시 : working-scala +### 파일 이름 +- 파스칼 케이스로 표기한다. +### main 클래스 이름 +- Main으로 통일한다. + + + +## 프로젝트 구조 +