Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ exclude = [
resolver = "2"

[workspace.package]
version = "0.3.0"
version = "0.4.0"
edition = "2021"
authors = ["E-NoR"]
license = "MIT OR Apache-2.0"
Expand Down
284 changes: 147 additions & 137 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions crates/ecp-analyzer/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "ecp-analyzer"
description = "EgentCodePlexus — multi-language tree-sitter parser and route detector (Rust, TypeScript, Python, Go, Java, Swift, etc.)"
version = "0.3.0"
version = "0.4.0"
edition.workspace = true
license.workspace = true
repository.workspace = true
Expand All @@ -11,7 +11,7 @@ build = "build.rs"
sha2 = "0.11.0"

[dependencies]
ecp-core = { path = "../ecp-core", version = "0.3.0" }
ecp-core = { path = "../ecp-core", version = "0.4.0" }
phf = { version = "0.13", features = ["macros"] }
tree-sitter = "0.26"
tree-sitter-typescript = "*"
Expand Down
8 changes: 4 additions & 4 deletions crates/ecp-cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "egent-code-plexus"
description = "EgentCodePlexus — code intelligence graph for AI agents and LLMs (multi-language AST analysis)"
version = "0.3.0"
version = "0.4.0"
edition.workspace = true
default-run = "ecp"
license.workspace = true
Expand All @@ -25,9 +25,9 @@ name = "ecp_cli"
path = "src/lib.rs"

[dependencies]
ecp-core = { path = "../ecp-core", version = "0.3.0" }
ecp-analyzer = { path = "../ecp-analyzer", version = "0.3.0" }
ecp-mcp = { path = "../ecp-mcp", version = "0.3.0" }
ecp-core = { path = "../ecp-core", version = "0.4.0" }
ecp-analyzer = { path = "../ecp-analyzer", version = "0.4.0" }
ecp-mcp = { path = "../ecp-mcp", version = "0.4.0" }
tokio = { version = "1", features = ["rt"] }
clap = { version = "4.5.4", features = ["derive"] }
serde = { version = "1.0", features = ["derive"] }
Expand Down
2 changes: 1 addition & 1 deletion crates/ecp-core/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "ecp-core"
description = "EgentCodePlexus — core graph storage and algorithms (zero-copy on-disk graph, registry, community detection)"
version = "0.3.0"
version = "0.4.0"
edition.workspace = true
license.workspace = true
repository.workspace = true
Expand Down
36 changes: 36 additions & 0 deletions docs/readme_i18n/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Translating the README

This directory holds non-English variants of the project README. The English one at the repo root is the source of truth; every other locale follows its structure 1-for-1.

## Adding or improving a translation

1. **Pick a locale code.** Use the [BCP-47](https://www.rfc-editor.org/info/bcp47) short form — `es`, `ru`, `ja`, `ko`, `hi`, `pt-BR`, etc. For Chinese variants we already split `zh-TW` and `zh-CN`.
2. **Copy the structure.** Mirror the section order from `README.md` exactly. The brutalist hero box, badges, metrics block, code blocks, tables, and `<details>` wrappers stay in English — only prose and table-cell descriptions get translated.
3. **Keep technical terms in English** when the native rendering would be awkward (e.g., `mmap`, `BlindSpot`, `BFS`, `TOON`, `MCP`, all flag names like `--mode bm25`). The README is a developer doc; precision beats native-vocabulary purity.
4. **Update the language picker** in every other locale file when you add a new one. The line right under the metrics block lists every available locale, with the current locale shown as `**bold**` (no link).
5. **Internal links must resolve.** Translation files live at `docs/readme_i18n/<file>.md`, so `../../LICENSE.md`, `../language-matrix.md`, and `./README_xx.md` are the right relative paths.

## Quality bar

We accept best-effort translations; we don't require certified-translator quality. What we do require:

- The 4 numbers in the metrics block stay accurate (cold index 2.60 s, query p50 142 ms, 31 languages, edge policy).
- The head-to-head + scalability tables stay numerically identical to the English version.
- The CLI command names, flag names, and JSON snippets stay byte-for-byte identical.
- The `[badges]` block stays identical across all locales.

If you spot a translation that says something different from the English source — open an issue or PR with the diff. Translations drift; they need contributors to keep them honest.

## Adding a brand-new locale

1. Create `docs/readme_i18n/README_<locale>.md` mirroring the English structure.
2. Insert the locale into the picker line in **every other README file** (root + each `docs/readme_i18n/README_*.md`).
3. (Optional) update [`README.md`](../../README.md)'s social card / GitHub repo description if you want the locale advertised at the project level.

## Removing a locale

If a translation goes stale and no one is maintaining it, prefer **removing it** over leaving a misleading out-of-date version online. Open a PR that:

1. Deletes `README_<locale>.md`.
2. Removes the locale from every picker line.
3. Notes in the PR body which sections diverged from English at time of removal, so a future contributor can resurrect the translation if they want.
Loading