https://github.com/andrijac/ruler

Simple on-screen pixel ruler.
https://github.com/andrijac/ruler

c-sharp desktop-application dotnet dotnet-standard ruler screen-pixel-ruler stylecop stylecop-warnings visual-studio winforms

Last synced: about 1 month ago
JSON representation

Simple on-screen pixel ruler.

• Host: GitHub
• URL: https://github.com/andrijac/ruler
• Owner: andrijac
• Created: 2014-04-22T12:59:25.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T02:03:08.000Z (3 months ago)
• Last Synced: 2024-09-30T23:43:30.746Z (about 1 month ago)
• Topics: c-sharp, desktop-application, dotnet, dotnet-standard, ruler, screen-pixel-ruler, stylecop, stylecop-warnings, visual-studio, winforms
• Language: C#
• Homepage:
• Size: 404 KB
• Stars: 424
• Watchers: 15
• Forks: 73
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
ruler

=====

Simple on-screen pixel ruler.

[](https://andrijac.visualstudio.com/ruler/_build/index?definitionId=e1a573e5-0959-4685-8cce-05da5e128d6a)








### Releases

https://github.com/andrijac/ruler/releases

### Legacy

Ruler is fork of small utility application originally developed by Jeff Key:

- http://ruler.codeplex.com/ :floppy_disk:

- ~~http://weblogs.asp.net/jkey/archive/2004/09/01/224433.aspx~~ :skull:

- ~~http://www.sliver.com/dotnet/ruler/~~ :skull:

### .NET version support

~~Support for .NET 2.0 is kept.~~

Last version with .NET 2.0 support is 1.6.

https://github.com/andrijac/ruler/releases/tag/1.6.0.0

Onward, Ruler will target .NET 4.6 which is deployed with Windows 10.

**Added features in this fork.**

### Contributions

If you want to contribute to project, please follow the rules:

1. **Zero-Warning policy**. There should be no C# compiler warnings in PR. :pray:

2. **Use StyleCop** Visual Studio Extension (by Chris Dahlberg) to check for StyleCop warnings https://marketplace.visualstudio.com/items?itemName=ChrisDahlberg.StyleCop. Zero-warning policy extends to StyleCop warnings. :cop: Custom StyleCop rules file is part of repository and it should be picked up by StyleCop in Visual Studio once you run it.

3. Keep in mind that **Ruler should be simple tool**. It should be disposable, easy to run, easy to close, easy to run in multiple instances. For now, I still refuse to add any kind of additional dependency to project like persistent storage for Ruler settings (which are still, at the moment, few), having a Ruler icon in system tray etc. for sake of keeping Ruler simple. Since Ruler can run multiple instances, features mentioned would add unnecessary complexity to project. :speech_balloon:

4. Use **Visual Studio ~~2017~~ 2019** with latest updates. :coffee:

### Ruler shortcuts:

- **Space** and **Double click**: will toggle direction of Ruler 

- **Arrow keys**: move Ruler (+ **Shift** for small step)

- **Ctrl** + **Arrow keys**: resize Ruler (+ **Shift** for small step)

- **Ctrl** + **S**: open resize form

### Command line parameters (optional):

In current implementation, you can either not use parameters (just start app) or use all parameters (you cannot used parameters selectively).

Parameters are intended to be used internally to duplicate Ruler by passing configuration to new instance, but you can use them to save prefered Ruler configuration too

The way parameters are passed to program and parsed might change in future.

`ruler.exe [Width:int] [Height:int] [IsVertical:bool] [Opacity:double] [ShowToolTip:bool] [IsLocked:bool] [TopMost:bool]`

Example:

`ruler.exe 100 50 false 0.6 true false true`

*Gifs are made using LICEcap http://www.cockos.com/licecap/*