Skip to content

Commit f2ea200

Browse files
authored
Update README.md
1 parent 5d44a53 commit f2ea200

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# [GDL-sublime](https://github.com/runxel/GDL-sublime)
22
A bundle to make GDL available in [Sublime Text](http://www.sublimetext.com/).
33

4-
[![Version](https://img.shields.io/badge/version-1.2.0-brightgreen.svg)]()
4+
[![Version](https://img.shields.io/badge/version-1.3.0-brightgreen.svg)]()
55

66
# What is GDL?
77
GDL means 'Geometric Description Language'. [ArchiCAD](http://www.graphisoft.com/) uses it to define a library part.
88

99
Many ArchiCAD users are making their own library parts, sell them or even publish them for free on sites like [BIMComponents](https://bimcomponents.com/), while others might modify the provided ones. But they are all tied to the – unfortunately horrible – build-in object editor which is stuck in the 80's or so. It doesn't even have line numbers!
1010

1111
But the rescue is here! _(at least something like that)_
12-
The purpose of this package is to give you the chance to comfortably write code in the best editor of the galaxy – Sublime Text.
12+
The purpose of this package is to give you the chance to comfortably write code in the best editor of the galaxy – [Sublime Text](https://www.sublimetext.com/).
1313

14-
This package provides **syntax highlighting** with a well aligned **color scheme** (aka syntax highlighting) and also **auto completion** (can be forced by pressing <kbd>ctrl</kbd> + <kbd>space</kbd>).
14+
This package provides **syntax highlighting** with a well aligned **color scheme** (so the syntax highlighting can take it's glorious place) and also **auto completion** (can be forced by pressing <kbd>ctrl</kbd> + <kbd>space</kbd>).
1515

1616
## Installation
1717

1818
### Using Sublime Package Control
1919
_recommended_
20-
If you are using [Sublime Package Control](http://wbond.net/sublime_packages/package_control), you can easily install the bundle via the `Sublime Text -> Preferences -> Package Control: Install Package` menu item.
20+
If you are using [Sublime Package Control](http://wbond.net/sublime_packages/package_control), you can easily install the bundle via the `Sublime Text -> Preferences > Package Control: Install Package` menu item.
2121

2222
### Using Git
2323
Alternatively you can install the bundle and keep up to date by cloning the repo directly into your `Packages` directory in the Sublime Text application settings area.
@@ -36,9 +36,10 @@ _not recommended – you won't get updates!_
3636
## Usage
3737
From now on you can select `GDL` as the current language in the bottom right corner of ST and enjoy all the benefits ST brings.
3838
But wait! There's more!
39-
You should activate a the color scheme (=proper highlighting) by modifying the syntax specific preferences file, which you can find using the menu item `Preferences -> Settings - More -> Syntax Specific – User`, after you set the syntax to `GDL` for the current file.
39+
You should activate a color scheme (meaning proper highlighting) by modifying the syntax specific preferences file.
40+
First set the syntax to `GDL` for the current file, then proceed to `Preferences > Settings – Syntax Specific`(or `Preferences > Settings – More > Syntax Specific – User` if youre using an older version of Sublime Text).
4041

41-
There are 2 different color schemes at choice: A dark and a light one. _I muchly recommend the dark one for fatigue-proof coding!_
42+
There are 2 different color schemes at choice: A dark and a light one. _I muchly recommend the dark one for fatigue-proof coding. If you're more the traditionell architect the light scheme might be your choice ;)_
4243

4344
Copy _one_ of these into the new file and save:
4445

@@ -57,9 +58,9 @@ Copy _one_ of these into the new file and save:
5758
```
5859

5960
#### Don't like the theme?
60-
Don't worry. Go to the [ththeme-editor](http://tmtheme-editor.herokuapp.com/) and select one of the two themes as start and make one which satisfies you! (Note that the theme-editor of course has no preview for gdl code, so it's just direct scope color editing.)
61+
Don't worry. Go to the [ththeme-editor](http://tmtheme-editor.herokuapp.com/#!/editor/theme/GDL dark) and select one of the two themes as start and make one which satisfies you! (Note that the theme-editor of course has no preview for gdl code, so it's just direct scope color editing.)
6162
_See the [Wiki](https://github.com/runxel/GDL-sublime/wiki) for a list with the scopes so you can refine the scheme to suit your needs._
62-
Of course you could also edit the `.thTheme` files directly. Remember not to edit the provided one. Otherwise an update would overwrite your changes.
63+
Of course you could also edit the `.thTheme` files directly. Remember to copy and rename the provided one. Otherwise an update would overwrite your changes.
6364

6465
### Auto completion + Snippets
6566
You may have to force the auto completion via <kbd>ctrl</kbd> + <kbd>space</kbd>.
@@ -70,8 +71,8 @@ Voilá! There's a divider.
7071
I hardly encourage you to either modify the snippets, so they will suit your needs; or to make new ones.
7172
You will find all the shipped snippets in the "Snippets" folder.
7273

73-
## Usage made even easier
74-
This Sublime Text packages got accompanied by [GDLnucleus](http://www.opengdl.org/Default.aspx?tabid=9748) (_not free_). GDLnucleus is a assistant program which enables you to send your changes live to ArchiCAD from Sublime Text, instead of relying on copy+paste.
74+
## Further usage
75+
This Sublime Text package got accompanied by [GDLnucleus](http://www.opengdl.org/Default.aspx?tabid=9748) (_Not freeware_). GDLnucleus is a assistant program which enables you to send your changes live to ArchiCAD from Sublime Text, instead of relying on copy+paste.
7576
It can be understood as a SublimeText-project handler integrated with a link to the LP_XMLConverter, which comes with ArchiCAD. See the page for more details.
7677
(_Please note: I did not made GDLnucleus._)
7778

0 commit comments

Comments
 (0)