chore: initialize EverOS 1.0.0
md-first memory extraction framework for AI agents. Markdown is the single source of truth; SQLite holds state and LanceDB provides the rebuildable vector + BM25 + scalar index. The codebase follows a single-direction DDD layering (entrypoints -> service -> memory -> infra, with component / core / config cross-cutting) enforced by import-linter. Engineering surface: - Coding conventions in .claude/rules/ (path-scoped) and workflows in .claude/skills/ (/commit, /new-branch, /pr). - GitHub Actions CI runs make lint + test + integration; pre-commit mirrors the gates locally (ruff, hygiene hooks, gitlint commit-msg). - Commit messages follow Conventional Commits, enforced by gitlint. - make lint also enforces datetime two-zone discipline and OpenAPI drift.
This commit is contained in:
65
CITATION.md
Normal file
65
CITATION.md
Normal file
@ -0,0 +1,65 @@
|
||||
# Citation
|
||||
|
||||
[Home](README.md) > [Docs](docs/index.md) > Citation
|
||||
|
||||
If you use **EverOS** in research or a published project, the suggested
|
||||
citation forms are below.
|
||||
|
||||
---
|
||||
|
||||
## Paper
|
||||
|
||||
📄 **Paper coming soon** — a technical paper is in preparation.
|
||||
|
||||
```
|
||||
Coming soon
|
||||
```
|
||||
|
||||
BibTeX citation information will be added here once the paper is published.
|
||||
|
||||
---
|
||||
|
||||
## BibTeX
|
||||
|
||||
```bibtex
|
||||
% Will be added when the paper is published
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Software citation
|
||||
|
||||
To cite the software itself:
|
||||
|
||||
```
|
||||
EverOS: md-first memory extraction framework for AI agents
|
||||
Version: 1.0.0
|
||||
URL: https://github.com/EverMind-AI/EverOS
|
||||
License: Apache 2.0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments in your work
|
||||
|
||||
If you use EverOS, we appreciate:
|
||||
|
||||
- Citing the paper (when available)
|
||||
- Starring the GitHub repository
|
||||
- Mentioning EverOS in your acknowledgments section
|
||||
|
||||
---
|
||||
|
||||
## Stay updated
|
||||
|
||||
- Watch the [GitHub repository](https://github.com/EverMind-AI/EverOS) for paper announcements
|
||||
- Follow [@EverMindAI](https://x.com/EverMindAI) on X / Twitter
|
||||
- Join [GitHub Discussions](https://github.com/EverMind-AI/EverOS/discussions)
|
||||
|
||||
---
|
||||
|
||||
## See also
|
||||
|
||||
- [Overview](docs/overview.md)
|
||||
- [Acknowledgments](ACKNOWLEDGMENTS.md)
|
||||
- [Changelog](CHANGELOG.md)
|
||||
Reference in New Issue
Block a user