Skip to content
Open
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
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ a better bookmark system for SublimeText
Unmaintained
============
Unfortunately, being a college student doesn't leave me with time to fix the bugs that people seem to be having with
this codebase. I do wish to rewrite this, since this was written when I was new to python. If **anyone** wishes to either
this codebase. I do wish to rewrite this, since this was written when I was new to python. If **anyone** wishes to either:
1. Take ownership of the package
2. Help me rewrite this

Please do ping me, help is very appreciated `:)`



Motivation
==========
Why SublimeBookmark?
====================

Let's face it: sublime text's bookmark system __sucks__.
__\<rant\>__
It doesn't support named bookmarks. It doesn't save bookmark statuses, and it is just terrible to use overall.
__\</rant\>__.

This is a replacement for sublime text's bookmark functionality. It's slicker and easier to use, and has way more features.
This is a drop-in replacement for sublime text's bookmark functionality. It's slicker, easier to use, and has way more features.

**Note**: <del> As of now, This is only for **Sublime Text 3**. </del> False! It's been ported. Unfortunately, I havent' implement live preview and project based bookmark sorting. I'm not sure how to port these features over to Sublime Text 2. If someone knows, please do contact me!d

Expand All @@ -34,53 +34,52 @@ Features
========

* Named bookmarks
* A Toggling command that actually works
* Bookmarks are saved across sessions
* Goto any bookmark in the project
* Add any number of bookmarks (not just 12).
* Project based bookmarks (bookmarks are stored per-project and bookmarks can be navigated on a per-project basis) (Only for ST3)
* Add any number of bookmarks (not just 12)
* Project based bookmarks (bookmarks are stored per-project and can be navigated on a per-project basis) (ST3 only)

To Install
==========
Installation
============

<!-- this is copy-pasted from sublimeCodeIntel. Thanks for the great description! -->

**With the Package Control plugin:** The easiest way to install SublimeBookmarks is through Package Control, which can be found at this site: http://wbond.net/sublime_packages/package_control
**Via PackageControl:** The easiest way to install SublimeBookmarks is through Package Control, which can be found at this site: http://wbond.net/sublime_packages/package_control

Once you install Package Control, restart Sublime Text and bring up the Command Palette (``Command+Shift+P`` on OS X, ``Control+Shift+P`` on Linux/Windows). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select SublimeBookmarks when the list appears. The advantage of using this method is that Package Control will automatically keep SublimeBookmarks up to date with the latest version.



**Without Git:** Download the latest source from `GitHub <https://github.com/bollu/SublimeBookmark/tree/st3>` and copy the whole directory into the Packages directory.

**With Git:** Clone the repository in your Sublime Text Packages directory, located somewhere in user's "Home" directory::

git clone -b st3 https://github.com/bollu/sublimeBookmark.git

To Use
Usage
======

###Adding Bookmarks###
### Adding Bookmarks

Go to a line you wish to bookmark. Press ```ctrl + shift + P``` on Windows / Linux or ```cmd + shift + P``` on Mac and type ```SublimeBookmarks:Add Bookmark```. This opens up a panel where you can type the name of your bookmark. Once you're done naming your shiny new bookmark, hit ```Enter```. You should see a tiny yellow triangle next to your line. you're done!


###Accessing Bookmarks###
### Accessing Bookmarks
Press ```ctrl + shift + P``` on Windows / Linux or ```cmd + shift + P``` on Mac and select ```SublimeBookmarks:Goto Bookmark```. This will bring up a list of all bookmarks. Type in the bookmark name you want to go to and press ```Enter``` to go to the bookmark


###Removing Bookmarks###
### Removing Bookmarks
Press ```ctrl + shift + P``` on Windows / Linux or ```cmd + shift + P``` on Mac and select ```Remove Bookmark```. Type the name of the bookmark you want to remove and press ```Enter```. This will remove the bookmark

To remove _all_ bookmarks, select the option ```SublimeBookmarks:Remove All Bookmarks (Clear Bookmarks)```. This will clear _all bookmarks_. This _can not be undone_.



##Visibility Modes:##
## Visibility Modes:

SublimeBookmarks has 3 visibility modes associated with it.
The default mode is option 2.

###1) View all Bookmarks###
### 1) View all Bookmarks

This mode shows *all* bookmarks that have been created - irrespective of project or file information.

Expand All @@ -90,15 +89,15 @@ The default mode is option 2.
This will show __all__ bookmarks created


###2) View only Project Bookmarks###
### 2) View only Project Bookmarks

This mode only shows bookmarksthat belong to the *current project* - it will not show other bookmarks *at all*

Press ```ctrl + shift + P``` on Windows / Linux or ```cmd + shift + P``` on Mac and select ```SublimeBookmarks:Show Only Bookmarks In Current Project```

This will only show bookmarks that belong to the current project.

###2) View only current file Bookmarks###
### 2) View only current file Bookmarks

This mode only shows bookmark that are present in the *current file*.

Expand All @@ -109,13 +108,13 @@ This will only show bookmarks that belong to the current file.
Notes / Addendum
================

###Some TODO Stuff:###
### TODO:

* <del>Port to Sublime Text 2 </del> (This is partially done. Unfortunately, I'm not able to implement live previews and project support. I don't really know how to port these to ST2. If someone does, please do contact me! )
* <del>Add an option to only show bookmarks belonging to current project </del> (Nope, it now fully supports project-based bookmark management!)


###To Help###
### Contributing

Just fork my repo and send a pull request. I'll gladly accept :)

Expand Down