Skip to content
This repository was archived by the owner on Oct 18, 2021. It is now read-only.

Commit 2aa0f27

Browse files
Mika MelikyanMika Melikyan
authored andcommitted
Updated readme
1 parent 9a788fc commit 2aa0f27

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# SublimeText-Overlay
2-
OS X like overlay on Sublime Text Editor.
1+
### Sublime Overlay [ BETA ]
2+
![img](http://i.imgur.com/tmJlAUj.png)
3+
4+
**Warning: Tested only on Windows 10 with Sublime Text 3.x. Please open an issue if it's working incorrectly.**
5+
6+
Ever wanted to make Sublime Text borderless like OS X?
7+
# Features:
8+
9+
* Adjustable offset of inner window.
10+
* Togglable title text
11+
* Adjutable primary color for overlay
12+
13+
*Note:* These settings are accesable through options window (button in top right corner)
14+
# Requirements:
15+
* [.NET Framework 4.5+](https://www.microsoft.com/en-us/download/details.aspx?id=42642)
16+
* Windows 7+
17+
18+
# Usage:
19+
20+
Open an instance of Sublime Text and run the executable of SublimeOverlay.
21+
Currently supports only 1 instance of editor.
22+
------
23+
# FAQ:
24+
25+
* Q: My editor borders are visible
26+
* A: **Adjust the top/left offsets in settings form.**
27+
28+
29+
* Q: Sublime Text **is not starting** after closing the SublimeOverlay instance.
30+
* A: *Most likely Sublime Text is in your processes*, use your task manager to kill the instance and try again, **or open RUN/CMD and type `taskkill /f /im sublime_text.exe` (warning: this will kill all sublime instances open)**

0 commit comments

Comments
 (0)