summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2021-09-02 17:08:36 +0200
committergregory guy <gregory-tde@laposte.net>2021-09-02 17:08:36 +0200
commit9525aceb310e544df609a28b15c0e115fc7330a1 (patch)
treec6249fc1a63734083a9e21a07a9e6a48f4c75e30 /README
parente621cacf5b6ab254622b5fc3b8c9c1f0f8585c66 (diff)
downloadkscope-9525aceb310e544df609a28b15c0e115fc7330a1.tar.gz
kscope-9525aceb310e544df609a28b15c0e115fc7330a1.zip
Drop automake build support.
Delete empty file NEWS. Add basic cmake build instructions. Rework of the README file. Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 47 insertions, 0 deletions
diff --git a/README b/README
index 8b13789..eca7fa4 100644
--- a/README
+++ b/README
@@ -1 +1,48 @@
+ 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