Skip to content

Commit

Permalink
Add history and usage images to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PatriciaSowa authored and felixauringer committed Aug 7, 2020
1 parent 4844735 commit 9292476
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,24 @@
dev: ![CI](https://github.com/hpi-swa-teaching/OhmPrettyPrint/workflows/CI/badge.svg?branch=dev)
master: ![CI](https://github.com/hpi-swa-teaching/OhmPrettyPrint/workflows/CI/badge.svg?branch=master)

OmegaPrint is a tool which prettifies your code in a consistent way. It uses [Ohm/S](https://github.com/hpi-swa/Ohm-S) as a parser.

## How to install
```smalltalk
Metacello new
baseline: 'OhmPrettyPrint';
baseline: 'OmegaPrint';
repository: 'github://HPI-SWA-Teaching/OhmPrettyPrint:dev/packages';
load
```

## Usage
After installing OmegaPrint you will find a button in all your code holders (for example the browser).
![Hovering over formatter selection](/screenshots/hover_formatting_selection.png)
![Formatter selection clicked](/screenshots/click_formatting_selection.png)

Selecting OmegaPrint will show you a prettified version of your code. Be aware that comments are not fully implemented yet.

For more information about the implementation visit our [wiki](https://github.com/hpi-swa-teaching/OhmPrettyPrint/wiki).

## History
- 2020: Tarik Alnawa, Felix Auringer, Paula Klinke, Patricia Sowa
Binary file added screenshots/click_formatting_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/hover_formatting_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9292476

Please sign in to comment.