Skip to content

Commit 5999219

Browse files
committed
Updated README
1 parent b009544 commit 5999219

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

README.markdown

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
Gedit Source Code Browser
22
=========================
33

4-
A source code class and function browser plugin for Gedit 3.
4+
![No Maintenance Intended](http://unmaintained.tech/badge.svg)
5+
6+
A source code class and function browser plugin for Gedit 3.
57

68
* Author: Micah Carrick
79

810
This plugin will add a new tab to the side pane in the Gedit text editor which
9-
shows symbols (functions, classes, variables, etc.) for the active document.
10-
Clicking a symbol in the list wil jump to the line on which that symbol is
11+
shows symbols (functions, classes, variables, etc.) for the active document.
12+
Clicking a symbol in the list wil jump to the line on which that symbol is
1113
defined.
1214

1315
See the [ctags supported languages](http://ctags.sourceforge.net/languages.html)
@@ -17,26 +19,26 @@ for a list of the 41 programming languages supported by this plugin.
1719
Requirements
1820
------------
1921

20-
This plugins is for Gedit 3 and is **not compatible with Gedit 2.x**.
22+
This plugins is for Gedit 3 and is **not compatible with Gedit 2.x**.
2123

22-
The Gedit Source Code Browser plugin uses
24+
The Gedit Source Code Browser plugin uses
2325
[Exuberant Ctags](http://ctags.sourceforge.net/) to parse symbols
2426
out of source code. Exuberant Ctags is avaialable in the software repository for
2527
many distributions. To make sure you have ctags correctly installed, issue
2628
the following command:
2729

2830
ctags --version
29-
31+
3032
Make sure that you see *Exuberant* Ctags in the version output.
3133

3234

3335
Installation
3436
------------
3537

36-
1. Download this repository by clicking the Downloads button at the top of the
38+
1. Download this repository by clicking the Downloads button at the top of the
3739
github page or issue the following command in a terminal:
3840

39-
git clone git://github.com/Quixotix/gedit-source-code-browser.git
41+
git clone git://github.com/MicahCarrick/gedit-source-code-browser.git
4042

4143
2. Copy the file `sourcecodebrowser.plugin` and the folder `sourcecodebrowser` to
4244
`~/.local/share/gedit/plugins/`.
@@ -45,33 +47,33 @@ Installation
4547

4648
4. Activate the plugin in Gedit by choosing 'Edit > Preferences', the selecting
4749
the 'Plugins' tab, and checking the box next to 'Soucre Code Browser'.
48-
50+
4951
5. (Optional) If you want to enable the configuration dialog you need to compile
5052
the settings schema. You must do this as root.
5153

5254
cd /home/<YOUR USER NAME>/.local/share/gedit/plugins/sourcecodebrowser/data/
53-
55+
5456
cp org.gnome.gedit.plugins.sourcecodebrowser.gschema.xml /usr/share/glib-2.0/schemas/
55-
57+
5658
glib-compile-schemas /usr/share/glib-2.0/schemas/
5759

5860
Screenshots
5961
-----------
6062

61-
![Python code in Source Code Browser](http://www.micahcarrick.com/images/gedit-source-code-browser/python.png)
63+
![Python code in Source Code Browser](screenshot.png)
6264

6365

6466
Known Issues
6567
------------
6668

6769
* CSS is not supported. This issue is about ctags and not this plugin. You can
68-
[extend ctags](http://ctags.sourceforge.net/EXTENDING.html) to add support for
69-
any language you like. Many people have provided their fixes to on internet
70+
[extend ctags](http://ctags.sourceforge.net/EXTENDING.html) to add support for
71+
any language you like. Many people have provided their fixes to on internet
7072
such as this [patch for CSS support](http://scie.nti.st/2006/12/22/how-to-add-css-support-to-ctags).
71-
73+
7274
* PHP is supported, however, PHP5 classes are not well supported. This is again
7375
an issue with ctags. There are numerous fixes to be found onn the internet
74-
such as these
76+
such as these
7577
[patches for better PHP5 support](http://www.jejik.com/articles/2008/11/patching_exuberant-ctags_for_better_php5_support_in_vim/).
7678

7779

@@ -81,27 +83,27 @@ License
8183
Copyright (c) 2011, Micah Carrick
8284
All rights reserved.
8385

84-
Redistribution and use in source and binary forms, with or without modification,
86+
Redistribution and use in source and binary forms, with or without modification,
8587
are permitted provided that the following conditions are met:
8688

87-
* Redistributions of source code must retain the above copyright notice, this
89+
* Redistributions of source code must retain the above copyright notice, this
8890
list of conditions and the following disclaimer.
89-
90-
* Redistributions in binary form must reproduce the above copyright notice,
91-
this list of conditions and the following disclaimer in the documentation
91+
92+
* Redistributions in binary form must reproduce the above copyright notice,
93+
this list of conditions and the following disclaimer in the documentation
9294
and/or other materials provided with the distribution.
93-
94-
* Neither the name of Micah Carrick nor the names of its
95-
contributors may be used to endorse or promote products derived from this
95+
96+
* Neither the name of Micah Carrick nor the names of its
97+
contributors may be used to endorse or promote products derived from this
9698
software without specific prior written permission.
9799

98-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
99-
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
100-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
101-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
102-
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
103-
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
104-
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
105-
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
106-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
100+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
101+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
102+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
103+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
104+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
105+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
106+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
107+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
108+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
107109
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

screenshot.png

22.5 KB
Loading

0 commit comments

Comments
 (0)