Skip to content

Commit

Permalink
imporve on instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Mallikarjunarao Kosuri committed Jul 26, 2018
1 parent fbfbedd commit 9052895
Showing 1 changed file with 36 additions and 17 deletions.
53 changes: 36 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,51 @@
# lang-robot
# Robotframework syntax highlighter for :pencil: **Notepad++**

Robotframework syntax highlighter for **Notepad++**
## Importing a user defind language in Notepad++

## Notepad++
1. Download the repository from GitHub https://github.com/vkosuri/npp-robot/archive/master.zip
2. Extract zipped file into local directory.
3. Open :pencil: Notepad++ on your machine.
4. From Menu Bar selecte Langugage -> User-Defined

## Importing a user defind language
![user-defined-pop-up](http://docs.notepad-plus-plus.org/images/1/1a/Udl_tuto02.gif "User-Defined")

Langugage -> User-Defined
5. Select Import

![alt text](http://docs.notepad-plus-plus.org/images/1/1a/Udl_tuto02.gif "User-Defined")
![import-undock](http://docs.notepad-plus-plus.org/images/8/80/Ulds_undock.png "Import")

Select Import
6. Select UDL xml **lang-robot.xml** file

![alt text](http://docs.notepad-plus-plus.org/images/8/80/Ulds_undock.png "Import")
After import you will observe the syntax highlighter start working :boom: :sparkles: :tada:

Select UDL xml **lang-robot.xml** file
> If you find any difficuty while importing ``lang-robot.xml`` This thread might help to resolve your issue. https://github.com/vkosuri/npp-robot/issues/3#issuecomment-305343247 [![](https://i.imgur.com/9wQkGeP.png)](../labels/comments)
Below screen shot summaries the how it looks and color represents
> The sytanx highligher works **<file_name>.robot** extension files only
```
Blue - Keywords
Orange - Variables
Green - Comments
```
A sample screenshot that summaries the how it looks.

![syntax-highlighter](https://cloud.githubusercontent.com/assets/13664257/12018694/650545a2-ad8c-11e5-8bf2-52719ab60f0a.png)

## Colors used
<p><span style="color:blue"><em>Blue</em> - Keywords</span>.</p>
<p><span style="color:orange"><em>Orange</em> - Variables</span>.</p>
<p><span style="color:green"><em>Green</em> - Comments</span>.

**After import the syntax will work .robot files only**
## History

See release notes for changes https://github.com/vkosuri/npp-robot/releases

## Development pattern for contributors

* Create a fork of the main repository on GitHub.
* Make your changes in a branch named something different from master, e.g. create a new branch my-pull-request.
* Create a pull request.

## Known issues
* [syntax highligher broken on certain charecters](https://github.com/vkosuri/npp-robot/issues/5) [![](https://i.imgur.com/hgS76Kz.png)](../labels/help-wanted) [![](https://i.imgur.com/Bie8PhC.png)](../labels/enhancement)

## License

This sytanx highlighter is licensed under the [MIT License](https://github.com/vkosuri/npp-robot/blob/master/LICENSE.md).

Enjoy ¯\\\_(ツ)\_

Enjoy...

0 comments on commit 9052895

Please sign in to comment.