Merge pull request #3 from yaaama/02-readme-fixes

doc: Spelling fixes
This commit is contained in:
agvxov 2024-11-07 07:17:30 +00:00 committed by GitHub
commit 618c56893e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -3,7 +3,7 @@
> Fork of Cscope version 15.9, with various improvements.
Because cscope is good and shall not be forgotten.
While the original's mainentence seems abandoned and as far as I can tell you need a PhD in autoconf to compile the latest version,
While the original's maintenance seems abandoned and as far as I can tell you need a PhD in autoconf to compile the latest version,
Csope is alive and well.
# Demo
@ -52,12 +52,12 @@ Csope is alive and well.
+---------------------Tool Tips--+ +--------------------------------+
# Usacases
Csope shines at exploring stranger and obsecure code bases due to its TUI.
It sometimes gets mislabeled as a code navigation tool, but the original documentation describes it best as a "code browsing tool".
Csope shines at exploring stranger and obscure code bases due to its TUI.
It sometimes gets mislabelled as a code navigation tool, but the original documentation describes it best as a "code browsing tool".
Many tools can jump you to a definition or grep for patterns,
but Csope is unqie in that it allows for those and many other functionalities while providing you with a very comprehansible list of all results,
but Csope is unique in that it allows for those and many other functionalities while providing you with a very comprehensible list of all results,
ready to fire up your editor at just the spot.
An example of its excelence is this project. The Cscope codebase used to be a total mess,
An example of its excellence is this project. The Cscope code-base used to be a total mess,
fixing it would have been a lost cause, if not for Cscope itself. Well, Csope now.
# Improvements/Changes
@ -70,7 +70,7 @@ fixing it would have been a lost cause, if not for Cscope itself. Well, Csope no
+ Reorganized the control flow
+ Encapsulated changes to the TUI into display.c
+ Encapsulated searching into find.c
+ Removed "scanner.l" which seems to be an anchient version (and redundant copy) of "fscanner.l" forgotten by all
+ Removed "scanner.l" which seems to be an ancient version (and redundant copy) of "fscanner.l" forgotten by all
+ Removed macro hell put in place to allow compiling on a dead badger
+ Use stdbool instead of YES/NO macros
+ Saved kilobytes by stripping trailing whitespace
@ -104,7 +104,7 @@ Start browsing your project by running csope over it's source dir.
# Configuration
## Readline
The readline integratoin should be complete -please let us know if not-, except for your prompt being used, which could easily break the TUIs display.
The readline integration should be complete -please let us know if not-, except for your prompt being used, which could easily break the TUIs display.
The rl_readline_name variable will be set to "Csope", so you may have conditional configurations in your .inputrc with the following format: