Skip to content

Commit

Permalink
Updated readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
houmain committed May 10, 2021
1 parent 3ecc551 commit 4612dde
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 12 deletions.
18 changes: 17 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]


## [Version 1.19] - 2021-05-10
## Added
- Added fullscreen option.
- Added saving/restoring session state.
- Added option to show whitespace.
- Highlighting matching brace.

## Changed
- Improved closing multiple modified files.
- Moved source validation/type to source editor toolbar.

## Fixed
- Fixed standalone shader validation.

## [Version 1.18] - 2021-04-16
## Added
- Added manual vertical texture flip control.
Expand Down Expand Up @@ -281,7 +296,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Version 1.0] - 2019-04-14

[Unreleased]: https://github.com/houmain/gpupad/compare/1.18...HEAD
[Unreleased]: https://github.com/houmain/gpupad/compare/1.19...HEAD
[Version 1.19]: https://github.com/houmain/gpupad/compare/1.18...1.19
[Version 1.18]: https://github.com/houmain/gpupad/compare/1.17...1.18
[Version 1.17]: https://github.com/houmain/gpupad/compare/1.16...1.17
[Version 1.16]: https://github.com/houmain/gpupad/compare/1.15...1.16
Expand Down
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@

GPUpad
======
A lightweight editor for GLSL shaders of all kinds and a fully-featured IDE for developing GPU based algorithms.

<p>
<a href="#features">Features</a> |
<a href="#screenshots">Screenshots</a> |
<a href="#introduction">Introduction</a> |
<a href="#download">Download</a> |
<a href="#introduction">Building</a> |
<a href="https://github.com/houmain/gpupad/blob/main/CHANGELOG.md">Changelog</a>
<br/>

<a href="https://github.com/houmain/gpupad/blob/master/LICENSE"><img alt="license" src="https://img.shields.io/github/license/houmain/gpupad"/></a>
<a href="#download"><img alt="platforms" src="https://img.shields.io/badge/Platforms-Linux%20%7C%20macOS%20%7C%20Windows-blue"/></a>
<br/>
<a href="https://github.com/houmain/gpupad/issues">
<img alt="Issues" src="https://img.shields.io/github/issues-raw/houmain/gpupad.svg"/></a>
<a href=""><img alt="size" src="https://img.shields.io/github/languages/code-size/houmain/gpupad"/></a>
</p>

Aims to be a lightweight editor for GLSL shaders of all kinds and a fully-featured IDE for developing GPU based algorithms.

Screenshots
-----------

<a href="screenshot2.png"><img src="screenshot2.png" height="380"></a> &nbsp;
<a href="screenshot1.png"><img src="screenshot1.png" height="280"></a>

Features
--------

* Cross platform and efficient.
* Decent source editor with automatic indentation, rectangular selection&hellip;
* Decent source editor with automatic indentation, brace highlighting, rectangular selection&hellip;
* GLSL and JavaScript syntax highlighting with basic auto completion (of built-in functions and constants).
* Continuous validation of standalone shader files (by compiling them using OpenGL).
* Possibility to evaluate shader programs with completely customizeable input and OpenGL state.
Expand All @@ -23,8 +34,15 @@ Features
* Reading and writing of image files ([KTX](https://github.com/KhronosGroup/KTX-Software) and DDS for 3D/Array textures, block compressed textures, cube maps&hellip;).
* Streaming video files to textures.
* Editor for structured binary files.
* Hot reloading of externally modified files.
* Sample sessions in the Help menu.

Screenshots
-----------

<a href="screenshot1.png"><img style="vertical-align: top" src="screenshot1.png" height="280"></a> &nbsp;
<a href="screenshot2.png"><img src="screenshot2.png" height="380"></a>

Introduction
------------

Expand Down Expand Up @@ -75,14 +93,14 @@ Allows to structure more complex sessions. They open a new scope unless *inline
Allows to define JavaScript functions and variables in script files, which can subsequently be used in uniform binding expressions.
There is one JavaScript state for the whole session and the scripts are evaluated in consecutive order (*Group* scopes do not have an effect).

Installation
------------
Download
--------

**Arch Linux and derivatives:**

An up to date build can be installed from the [AUR](https://aur.archlinux.org/packages/gpupad-git/).

**Other Linux distributions, Windows, macOS:**
**Windows, macOS and other Linux distributions:**

A portable build can be downloaded from the [latest release](https://github.com/houmain/gpupad/releases/latest) page.

Expand Down
Binary file modified screenshot1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4612dde

Please sign in to comment.