summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2021-10-18 01:54:16 +0200
committerSlávek Banko <slavek.banko@axis.cz>2021-10-18 01:54:52 +0200
commit1577c3b1f216305972dc63b9c7662b32c30906bc (patch)
treea59892fbf451c572c735df396b214483722cfa4e /README.md
parent7a6023d275ed8a70b51de2bc15fe8b440ecacd41 (diff)
downloadkscope-1577c3b1f216305972dc63b9c7662b32c30906bc.tar.gz
kscope-1577c3b1f216305972dc63b9c7662b32c30906bc.zip
Change README to markdown format.r14.0.11
Add translation status overview. Signed-off-by: Slávek Banko <slavek.banko@axis.cz> (cherry picked from commit 9ecbe75ef7ffb3a7d57257cf77b91889fdc8bfc6)
Diffstat (limited to 'README.md')
-rw-r--r--README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..591e154
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+
+ kscope - a front-end to Cscope for TDE.
+
+
+KScope provides a source-editing environment for C projects with
+a focus on source editing and analysis.
+
+
+KScope is built around an efficient mechanism for code-navigation which
+allows the user to run queries on the code.
+
+The types of queries KScope can run include:
+
+* Get all references to a symbol
+* Find the definition of a symbol
+* Find all functions called by or calling to a function
+* Find an EGrep pattern
+* Find all files
+
+These queries are handled by a Cscope process; kscope serves as
+a front-end to this process, feeding it with queries and parsing
+its output into result lists. The items in those lists can be selected
+to open an editor at the matching line.
+
+
+Main Features:
+--------------
+
+* Multiple editor windows (using your favourite TDE editor)
+* Project management
+* Front-end to most Cscope queries
+* Tag list for every open editor
+* Call-tree window
+* Session management, including saving and restoring queries
+* Works with externally-built cscope.out files
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to kscope, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/weblate
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kscope/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kscope/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kscope-kscopedesktop/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kscope-kscopedesktop/)