added: added a document setting out the approach in words.

This commit is contained in:
vorotamoroz
2026-09-08 12:45:33 +01:00
parent dd280a4c5e
commit ac9b458fc9
5 changed files with 386 additions and 0 deletions
+28
View File
@@ -0,0 +1,28 @@
# Self-hosted LiveSync technical paper manuscript
This directory contains a technical manuscript prepared in the format of the Journal of Open Source Software (JOSS) to document the design intent, architecture, and workflow context of Self-hosted LiveSync.
This document is not currently published as a formal journal paper; rather, it serves as an architectural overview explaining the project's background and replication model (describing Self-hosted LiveSync 1.0.23 pinned to Commonlib 0.1.21). If you reference or utilise Self-hosted LiveSync in academic research, laboratory workflows, or technical publications, citing the software via [CITATION.cff](../CITATION.cff) or this manuscript is greatly appreciated.
## Contents
- [paper.md](paper.md): English manuscript.
- [paper.ja.md](paper.ja.md): Japanese reference translation.
- [paper.bib](paper.bib): Shared bibliography.
## Citing Self-hosted LiveSync
Please refer to the repository's [CITATION.cff](../CITATION.cff) file or the metadata recorded in [paper.bib](paper.bib) if you wish to cite this software in your research papers, technical reports, or presentations.
## Feedback and Contributions
For corrections, suggestions, or questions regarding the manuscript, please open an [issue](https://github.com/vrtmrz/obsidian-livesync/issues) or submit a pull request.
---
## 本原稿について
本ディレクトリーには、Journal of Open Source SoftwareJOSS)の形式を想定し、Self-hosted LiveSync の設計意図やアーキテクチャー、および運用の背景をまとめた原稿を配置しています。
本稿は現時点で正式に出版された論文ではなく、プロジェクトの背景や同期モデルを整理した技術資料として作成されたものです(Commonlib 0.1.21 に固定された Self-hosted LiveSync 1.0.23 を基準としています)。もし学術研究、実験ノートの管理、あるいは技術レポート等で Self-hosted LiveSync を利用・言及される機会がありましたら、リポジトリーの [CITATION.cff](../CITATION.cff) や本稿を引用していただけますと幸いです。
日本語版は翻訳メモリーを使用可能な逐語訳として記述されており、技術的な意味論の正確性は英語版を基準としています。