Skip to content

Commit 06c2e98

Browse files
committed
Create README.md
1 parent ce65e8b commit 06c2e98

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# GDL-sublime
2+
A bundle to make GDL available (meant as easy) in [Sublime Text](http://www.sublimetext.com/).
3+
4+
# What is GDL?
5+
GDL means 'Geometric Description Language'. [ArchiCAD](http://www.graphisoft.com/) uses it to define a library part (it's also used internally for nearly everything).
6+
7+
Many users of ArchiCAD are making their own library parts. 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!
8+
9+
But the rescue is ~~here~~ in the near future!
10+
The purpose of this package is to comfortably write code in the best editor of the galaxy – Sublime Text! ;)
11+
12+
## Installation
13+
Installation is not recommended at this time.
14+
No, really! Do it at your own risk and only for testing, if you're sure what you're doing.
15+
16+
### ~~Using Sublime Package Control~~
17+
_currently not available in your country. it will be later_
18+
19+
### Using Git
20+
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.
21+
22+
Go to your Sublime Text `Packages` directory and clone the theme repository using the command below:
23+
`git clone https://github.com/runxel/GDL-sublime "GDL"`
24+
25+
### Download Manually
26+
- Download the files using the GitHub .zip download option
27+
- Unzip the files and rename the folder to 'GDL'
28+
- Copy the folder to your Sublime Text `Packages` directory e.g.
29+
- Windows `C:\Users\yourname\AppData\Roaming\Sublime Text 2\Packages\GDL`
30+
- OS X: `~/Library/Application Support/Sublime Text 2/Packages/GDL`
31+
32+
## Usage
33+
From now on you can select 'GDL' as the current language in the bottom right corner of ST.
34+
35+
## Getting Started With Sublime Text
36+
New to Sublime? Then I can recommend the excellent and free video tutorial by nettuts: [Perfect Workflow in Sublime Text](http://net.tutsplus.com/articles/news/perfect-workflow-in-sublime-text-free-course/).
37+
38+
## TO DO LIST
39+
+ nearly everything :D
40+
41+
Roadmap is to implement the syntax first and then also distributing a beatiful custom theme so you can make the best out of the syntax.
42+
Goodies: Snippets, Tag completion

0 commit comments

Comments
 (0)