Sakura Editor
- Sakura Editor
A free Japanese text editor for Windows
Hot topic
Project(カンバン)運用を始めます。
Web Site
開発参加ポリシー
開発ポリシーを以下にまとめていきます。開発にご参加いただける方はこちらご参照ください。
https://github.com/sakura-editor/sakura/wiki
Build Requirements
Sakura Editor をコンパイルするためにはいずれかが必要
正式バイナリは Visual Studio Community 2017 でビルドされます。
Visual Studio Install options required
- Windows SDK
- Windows XP Support for C++
- Windows 8.1 SDK と UCRT SDK
- C++ に関する Windows XP サポート
More information: https://github.com/sakura-editor/sakura/issues/6
Visual Studio Community 2019 対応に関して
Visual Studio 2017/2019 の両対応に関しては #866 で対処済みです。
仕組みに関してはこちらを参照
.vsconfig に関して
Sakura Editor のコンパイルに必要なコンポーネントを Visual Studio 2017/2019 にインストールするために .vsconfig という設定ファイルを用意しています。
#1162 で .vsconfig というファイルを sakura.sln と同じディレクトリに配置しています。
Visaul Studio 2017/2019 共通
vs_community__XXXXX.exe でインストールする際に、--config オプションをつけてインストールする。
あるいは構成変更することにより、必要なコンポーネントを自動的にインストールします。
vs_community__XXXXX.exe --config <.vsconfig のファイルパス>
Visaul Studio 2019 のみ
sakura.sln と同じディレクトリに .vsconfig が存在するので、
Visaul Studio 2019 で sakura.sln を開くと必要なコンポーネントが足りない場合、インストールを促す表示が出るので、インストールをクリックすると自動的にインストールする。
参照
- How to extract currently installed Visual Studio component IDs?
- Configure Visual Studio across your organization with .vsconfig
- インストール構成をインポートまたはエクスポートする
- コマンド ライン パラメーターを使用して Visual Studio をインストールする
- 不足しているコンポーネントを自動的にインストールする
How to build
- 7Zip のインストールして 7z.exe へのパスを通します。
- Visual Studio Community 2017 で
sakura.slnを開いてビルドします。
詳細情報
詳しくは こちら を参照
CI Buildおよびローカルビルドの環境変数
CI でのビルド を参照
PR(Pull Request) を簡単にローカルに取得する方法
CI Build (Azure Pipelines)
ビルドの仕組み (Azure Pipelines)
azure-pipelines.md でビルドの仕組みを説明しています。
CI Build (AppVeyor)
ビルドの仕組み (AppVeyor)
appveyor.md でビルドの仕組みを説明しています。
ビルド成果物を利用する上での注意事項
これ を読んでからご利用ください。
x64 版は alpha 版です。
対応中のため予期せぬ不具合がある可能性があります。
ビルド成果物のダウンロード(バイナリ、インストーラなど)
master の 最新
- https://ci.appveyor.com/project/sakuraeditor/sakura/branch/master にアクセスする
- 右端にある
Jobsをクリックします。 - 自分がダウンロードしたいビルド構成 (例:
Configuration: Release; Platform: Win32) をクリックします。 - 右端にある
ARTIFACTSをクリックします。 - 自分がダウンロードしたいものをクリックしてダウンロードします。
- (ユーザー用) 末尾に
Exeがついてるのが実行ファイルのセットです。 - (ユーザー用) 末尾に
Installerがついてるのがインストーラのセットです。 (すべて欲しい人向け)(#514 の軽減のため無効化中)Allがついてるのがバイナリ、インストーラ、ビルドログ、アセンブラ出力のフルセットです。- (開発者用) 末尾に
Logがついてるのがビルドログのセットです。 - (開発者用) 末尾に
Asmがついてるのがアセンブラ出力セットです。
- (ユーザー用) 末尾に
master の 最新以外
以下から取得したいビルドを選択後、同様にしてダウンロードできます。
https://ci.appveyor.com/project/sakuraeditor/sakura/history
開発情報
単体テスト
単体テスト を参照
デバッグ方法
変更履歴
変更履歴は github-changelog-generator というソフトを使用して
changelog-sakura のリポジトリで appveyor で自動的に生成します。
生成した CHANGELOG.md は ここからダウンロードできます
ダウンロードした CHANGELOG.md は
Markdown をローカルで確認する方法
で説明している手順でローカルで確認できます。
CHANGELOG.mdについて のページにCHANGELOG.md に関する説明を記載しています。
マクロのサンプル
こちらでマクロのサンプルを提供してます。
もしサンプルを作ってもいいよ～という方がおられましたら PR の作成お願いします。
静的コード解析
- CodeFactor を利用しています。
- cpplint.py で cpp のスタイルのチェックを行っています。