Skip to content

Commit a5cd67e

Browse files
authored
get package created (#6)
1 parent 0901969 commit a5cd67e

14 files changed

+4271
-13
lines changed

.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# generate files
2+
node_modules/
3+
build/
4+
cmake-build-debug/
5+
6+
# log files
7+
*.log

.idea/.gitignore

-8
This file was deleted.

.idea/cmake.xml

+12
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/workspace.xml

+106
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"C_Cpp.errorSquiggles": "Disabled"
3+
}

README

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Omega Edit Library
2+
The goal of this project is to provide an open source library for building editors that can handle massive files.

README.md

+57-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Omega Edit Library
22
The goal of this project is to provide an open source library for building editors that can handle massive files.
33

4-
## cmake
5-
This repo is built heavly using CLion, if using CLion everything will work seamlessly.
4+
## Requirements
5+
This repo is built heavly using CLion, if using CLion everything will work seamlessly. (cmake)
66

77
If you are using just the command line you will need these things installed:
88
- C++ Compiler
99
- CMake (https://cmake.org/download/)
10+
- NodeJS 10
11+
- Swig
1012

1113
## cmake commands
1214
:exclamation: These commands should be built at root level of the repo :exclamation:
@@ -33,4 +35,56 @@ Run tests
3335
cd cmake-build-debug/tests/
3436
./omega_test -d yes --order lex
3537
cd ../../
36-
```
38+
```
39+
40+
## swig
41+
Build wrapper classes
42+
```bash
43+
swig -javascript -node -c++ omega_edit/omega_edit.i
44+
```
45+
46+
## node-gyp
47+
:exclamation: run `yarn install` before trying to other commands :exclamation:
48+
49+
Configure
50+
```
51+
yarn run gyp-configure
52+
```
53+
54+
Build
55+
```
56+
yarn run gyp-build
57+
```
58+
59+
## run script
60+
The run scripts allow for easy execution of the commands stated above.
61+
62+
cmake build
63+
```bash
64+
./run cmake-build
65+
```
66+
67+
cmake debug
68+
```bash
69+
./run cmake-build
70+
```
71+
72+
cmake test
73+
```bash
74+
./run cmake-test
75+
```
76+
77+
swig compile
78+
```bash
79+
./run swig-compile
80+
```
81+
82+
gyp configure
83+
```bash
84+
./run gyp-configure
85+
```
86+
87+
gyp build
88+
```bash
89+
./run gyp-build
90+
```

binding.gyp

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"targets": [
3+
{
4+
"target_name": "omega_edit",
5+
"sources": [ "omega_edit/omega_edit.cpp", "omega_edit/omega_edit_wrap.cxx"]
6+
}
7+
]
8+
}

omega_edit/omega_edit.i

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
%module omega_edit
2+
%{
3+
/* Includes the header in the wrapper code */
4+
#include "omega_edit.h"
5+
%}
6+
/* Parse the header file to generate wrappers */
7+
%include "omega_edit.h"

0 commit comments

Comments
 (0)