sakura

사쿠라 에디터

• 사쿠라 에디터
  • Hot topic
  • Web Site
  • 개발 참여 정책
  • Build Requirements
    • Visual Studio Install options required
    • Visual Studio 2019 이상 지원
    • .vsconfig 관련
      • 모든 지원 버전 공통
      • Visual Studio 2019 이상 전용
      • 참조
  • How to build
    • 자세한 정보
  • CI Build 및 로컬 빌드 환경 변수
  • PR (Pull Request)을 쉽게 로컬로 얻는 방법
  • CI Build (Azure Pipelines)
    • 빌드의 작동 방식 (Azure Pipelines)
  • CI Build (AppVeyor)
    • 빌드 메커니즘(AppVeyor)
    • 빌드 아티팩트를 이용하기 위한 주의사항
    • 빌드 아티팩트 다운로드 (바이너리, 설치 프로그램 등)
      • master 최신
      • 마스터의 최신 이외
  • 개발 정보
    • 단위 테스트
    • 디버깅 방법
  • 변경 내역
  • 매크로 샘플
  • 정적 코드 분석

A free Korean text editor for Windows

Hot topic

Project(칸방) 운용을 시작합니다.

• 프로젝트
• 칸방 운영

Web Site

• 사쿠라 에디터 포털

개발 참여 정책

개발 정책을 아래에 정리해 갑니다.
https://github.com/sakura-editor/sakura/wiki

Build Requirements

Sakura Editor를 컴파일하려면 최신 Visual Studio 또는 이전 버전의 Visual Studio(Visual Studio 2017 이상. 그러나 Windows Desktop용 Express 2017 제외)가 필요합니다.

Sakura Editor는 Open Source Initiative (OSI) 인증 라이센스 인 zlib 라이센스를 기반으로하므로 일반적으로 커뮤니티 에디션의 대상이 아닌 엔터프라이즈 조직에서도 커뮤니티 에디션을 사용하여 개발 및 테스트 할 수 있습니다. 물론 Professional 및 Enterprise 에디션도 사용할 수 있습니다.

공식 바이너리는 Visual Studio Community 2017에서 빌드됩니다.

Visual Studio Install options required

• Windows 10 SDK

Visual Studio 2019 이상 지원

Visual Studio 버전	지원됨 Issue/PR
2022	#1872(커밋)
2017/2019 동시	#866

구조에 관해서는 여기를 참조

.vsconfig 관련

Sakura Editor를 컴파일하는 데 필요한 구성 요소를 Visual Studio에 설치하기 위해 .vsconfig라는 구성 파일을 제공합니다.

# 1162에서 .vsconfig라는 파일은 sakura.sln과 동일한 디렉토리에 있습니다.

모든 지원 버전 공통

vs_community__XXXXX.exe 로 설치할 때 --config 옵션을 사용하여 설치하거나 구성을 변경하여 필요한 구성 요소를 자동으로 설치합니다.

 vs_community__XXXXX.exe --config <.vsconfig のファイルパス>

Visual Studio 2019 이상 전용

최신 Visual Studio(Visual Studio 2019 이상)에서 sakura.sln 을 열면 동일한 디렉터리에 있는 .vsconfig에서 필요한 구성 요소 목록이 로드됩니다. 설치되지 않은 구성 요소가 있는 경우 설치 단추가 표시됩니다. 설치를 클릭하면 누락된 구성 요소가 자동으로 설치됩니다.

참조

• How to extract currently installed Visual Studio component IDs?
• Configure Visual Studio across your organization with .vsconfig
• 설치 구성 가져오기 또는 내보내기
• 명령줄 매개 변수를 사용하여 Visual Studio 설치
• 누락된 구성 요소를 자동으로 설치

How to build

• 7-Zip을 설치하고 7z.exe 경로를 통과합니다.
• Visual Studio에서 sakura.sln 을 열고 빌드합니다.

자세한 정보

자세한 내용은 여기를 참조

CI Build 및 로컬 빌드 환경 변수

여기를 참조하십시오.

PR (Pull Request)을 쉽게 로컬로 얻는 방법

• PR (Pull Request)을 쉽게 로컬로 얻는 방법

CI Build (Azure Pipelines)

빌드의 작동 방식 (Azure Pipelines)

azure-pipelines.md에서 빌드의 작동 방식을 설명합니다.

CI Build (AppVeyor)

빌드 메커니즘(AppVeyor)

AppVeyor에서는 build-all.bat를 사용하여 빌드를 수행합니다. 빌드에 사용되는 배치 파일에 대해서는 build-batchfiles.md를 참조하십시오.

빌드 아티팩트를 이용하기 위한 주의사항

これ읽고 나서 이용하십시오.

x64 版は alpha 版입니다.
대응 중이기 때문에 예기치 않은 고장이 있을 가능성이 있습니다.

빌드 아티팩트 다운로드 (바이너리, 설치 프로그램 등)

master 최신

1. https://ci.appveyor.com/project/sakuraeditor/sakura/branch/master로 이동
2. 오른쪽 끝에 있는 Jobs 를 클릭합니다.
3. 다운로드하려는 빌드 구성(예: Configuration: Release; Platform: Win32 )을 클릭합니다.
4. 오른쪽 끝에 있는 ARTIFACTS 를 클릭합니다.
5. 자신이 다운로드하고 싶은 것을 클릭하여 다운로드합니다.
   • (사용자용) 끝에 Exe 가 붙어 있는 것이 실행 파일세트입니다.
   • (사용자 용) 끝에 Installer 붙어있는 것이 설치 프로그램 세트입니다.
   • (모두 원하는 사람을 위한) All 이 붙어 있는 것이 바이너리, 인스톨러, 빌드 로그, 어셈블러 출력의 풀 세트입니다. (# 514 완화로 인해 비활성화 중)
   • (개발자용) 말미에 Log 붙어 있는 것이 빌드 로그세트입니다.
   • (개발자용) 말미에 Asm 붙어 있는 것이 어셈블러 출력 세트입니다.

마스터의 최신 이외

아래에서 얻고 싶은 빌드를 선택한 후 마찬가지로 다운로드 할 수 있습니다.
https://ci.appveyor.com/project/sakuraeditor/sakura/history

개발 정보

단위 테스트

여기를 참조하십시오.

디버깅 방법

• 작업 트레이의 메뉴 항목을 디버깅하는 방법 참조
• 큰 파일을 만드는 방법

변경 내역

• 변경 내역은 CHANGELOG.md를 참조하십시오.
• 최신 CHANGELOG.md 는 여기에서 다운로드 할 수 있습니다.
• CHANGELOG.md 는 PullRequest에서 자동으로 생성됩니다.
  • 구체적으로는 github-changelog-generator라는 소프트웨어를 사용하여 changelog-sakura의 리포지토리에서 appveyor로 생성하고 있습니다.
  • 자세한 내용은 wiki의 CHANGELOG.md 정보를 참조하십시오.

매크로 샘플

여기에 매크로 샘플을 제공합니다.
만약 샘플을 만들어도 좋다 ~라는 분이 계시면 PR 의 작성 부탁합니다.

정적 코드 분석

• CodeFactor를 이용하고 있습니다.
  • cpplint.py에서 cpp 스타일을 확인합니다.