Skip to content

Commit f6e1bac

Browse files
author
reidspencer
committed
Add Open Source download instructions.
1 parent c088924 commit f6e1bac

4 files changed

Lines changed: 66 additions & 0 deletions

File tree

docs/OSS/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Ossum Open Source Software
2+
3+
In this section you will find open source software released by Ossum Inc. Feel free to try it out! There is no charge
4+
for using this Ossum software!
5+
6+
Here are the open source projects:
7+
8+
* [RIDDL](./riddl/index.md)
9+
* [VS Code Extension For RIDDL](./vscode-extension/index.md)
10+
* [IntelliJ IDEA Plugin](./intellij-plugin/index.md)
11+
12+
---
13+
14+
If you have any questions or need assistance, please contact our support team at support@ossuminc.com
15+
16+
If you are interested in contributing to our open source projects, please visit our GitHub organization at
17+
https://github.com/ossuminc.
18+
19+

docs/OSS/intellij-plugin/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# IntelliJ IDEA Plugin
2+
3+
This plugin provides support for the RIDDL language in IntelliJ IDEA.
4+
5+
# BETA Program
6+
7+
To install the plugin, download the latest release from the [GitHub Releases](https://github.com/riddl-org/riddl/releases) page.

docs/OSS/vscode-extension/index.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# VS Code Extension For RIDDL
2+
3+
This extension provides support for the RIDDL language in Visual Studio Code. It includes
4+
syntax highlighting, code completion, and other features to enhance your development
5+
experience with RIDDL.
6+
7+
## BETA Program
8+
9+
Currently this extension is in beta. To access it, download from
10+
Send them the .vsix file and these instructions:
11+
12+
0. Download the [.vsix file from Ossum's Public/OSS folder](https://drive.google.com/uc?export=download&id=1DYyEkG77uXvAnmr_-OSUgizkDZk0TGOR
13+
) to your computer
14+
1. Open VS Code
15+
2. Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux)
16+
3. Type "Install from VSIX" and select it
17+
4. Browse to the downloaded riddl-vscode-0.9.0.vsix file
18+
5. Click "Install" and reload VS Code
19+
20+
Or via command line:
21+
code --install-extension /your/path/to/riddl-vscode-0.9.0.vsix
22+
23+
## Released Product
24+
25+
When this product is released as version 1.0, it will be available from the VS Code Marketplace.
26+
To install from there, just:
27+
28+
1. Open VS Code
29+
2. Click on the Extensions tab in the left sidebar
30+
3. Type "Riddl" in the search bar and select the Riddl extension from the list
31+
4. Click "Install" and reload VS Code
32+
33+
---
34+
35+
If you have any questions or need assistance, please contact our support team at support@ossuminc.com
36+
37+
If you interest in contributing to this extension, please visit our GitHub repository at
38+
https://github.com/ossuminc/vscode-extension-riddl.
39+

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This site provides documentation for technologies created at Ossum, Inc.
77

88
THe sections at the top correspond to our products:
99

10+
* [OSS](oss/index.md)
1011
* [RIDDL](riddl/index.md)
1112
* [Synapify](synapify/index.md)
1213
* [Docify](docify/index.md)

0 commit comments

Comments
 (0)