Skip to content

Commit

Permalink
Create base project and base loader
Browse files Browse the repository at this point in the history
  • Loading branch information
lmariscal committed Nov 2, 2019
0 parents commit 34844cb
Show file tree
Hide file tree
Showing 11 changed files with 871 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
@@ -0,0 +1,15 @@
# find your plugin here: http://editorconfig.org/
# always follow this rules

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
165 changes: 165 additions & 0 deletions .gitignore
@@ -0,0 +1,165 @@
### C ###
# Prerequisites
*.d

# Object files
*.o
*.ko
*.obj
*.elf

# Linker output
*.ilk
*.map
*.exp

# Precompiled Headers
*.gch
*.pch

# Executables
*.exe
*.out
*.app
*.i*86
*.x86_64
*.hex

# Debug files
*.dSYM/
*.su
*.idb
*.pdb

# Kernel Module Compile Results
*.mod*
*.cmd
.tmp_versions/
modules.order
Module.symvers
Mkfile.old
dkms.conf

### C++ ###
# Prerequisites

# Compiled Object files
*.slo

# Precompiled Headers

# Compiled Dynamic libraries

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai

# Executables

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### Nim ###
nimcache/

### OSX ###

# Icon must end with two \r

# Thumbnails

# Files that might appear in the root of a volume

# Directories potentially created on remote AFP share

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.history

### Windows ###
# Windows thumbnail cache files
Thumbs.db
ehthumbs.db
ehthumbs_vista.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Binaries
[Bb]in/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk

# Dynamic Libraries
*.dll
*.so
*.dylib

### NimGL ###

# Tests
tests/general
tests/tgeneral
tests/tglfw
tests/tmath
tests/topengl
imgui.ini
docs/

# End of https://www.gitignore.io/api/c,osx,nim,c++,linux,macos,windows,visualstudiocode
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Leonardo Mariscal

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
84 changes: 84 additions & 0 deletions README.md
@@ -0,0 +1,84 @@
[![docs](https://img.shields.io/badge/docs-passing-4caf50.svg?style=flat-square)](https://nimgl.dev/docs)

# Modern OpenGL Bindings for Nim [![Nimble](https://raw.githubusercontent.com/yglukhov/nimble-tag/master/nimble.png)](https://github.com/nim-lang/nimble)

Separated module from [NimGL](https://nimgl.dev/). In order to mantain small
sized modules to facilitate development and reduce number of required modules.

Some developers do not require the entire bundle of APIs that
[NimGL](https://nimgl.dev/) offer, and so, prefere to only download the required
modules.

## Installation

### Nimble download

You can install this package through the official package manager of Nim.

```bash
$ nimble install https://github.com/nimgl/opengl.git
```

In order to respect already existing libraries in the package registry, and
because [NimGL](https://nimgl.dev/) already exists in there, this package is
only able to be accesible by direct git url.

### Nimble direct install

```bash
$ git clone --recursive -j8 https://github.com/nimgl/opengl.git
$ cd opengl
$ nimble install
```

### NimGL module

```bash
$ nimble install nimgl
```

You can find more information in the [main repo](https://github.com/nimgl/nimgl).

### Development

It is currently being developed and tested on

* Windows 10
* MacOS Mojave
* Linux Ubuntu 18.10

## Contribute

I'm only one person and I use this library almost daily for school and personal
projects. If you are missing some extension, procedures, bindings or anything
related feel free to PR them or open an Issue with the specification and
if you can some examples to have an idea on how to implement it.
Thank you so much :tada:

### This being a separate module behaves slightly diferently.

Please open all issues in the [main repository](https://github.com/nimgl/nimgl).
The PRs and new feature development will occur in each binding's repo.

## Usage

```nim
import opengl
# TODO
```

Check out the references and doc in order to understand OpenGL usage.

## License

[MIT License](https://github.com/nimgl/nimgl/blob/master/LICENSE)

NimGL is open source and is under the MIT License, we highly encourage every
developer that uses it to make improvements and fork them here.

## Contributors

Thank you to every contributor that has spent their time improving this library.

[List of all contributors.](https://github.com/nimgl/nimgl/graphs/contributors)
19 changes: 19 additions & 0 deletions opengl.nimble
@@ -0,0 +1,19 @@
# Package

version = "0.1.0"
author = "Leonardo Mariscal"
description = "OpenGL bindings for Nim"
license = "MIT"
srcDir = "src"
skipDirs = @["tests"]

# Dependencies

requires "nim >= 1.0.0"

task gen, "Generate bindings":
exec("nim c -r tools/generator.nim")

task test, "Build an test bindings":
requires "nimgl@#1.0" # Please https://github.com/nim-lang/nimble/issues/482
exec("nim c -r tests/test.nim")

0 comments on commit 34844cb

Please sign in to comment.