Skip to content

Commit

Permalink
- Correct readme
Browse files Browse the repository at this point in the history 
- simplify gitignore
  • Loading branch information
@billyquith
billyquith committed Jul 31, 2016
1 parent a1f5402 commit 5f461bd
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 204 deletions.
196 changes: 3 additions & 193 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,197 +1,7 @@

*.doxcfg

#################
## Cmake
#################

CMakeCache.txt
CMakeFiles
CMakeScripts
Makefile
cmake_install.cmake
install_manifest.txt

.ninja_deps
.ninja_log
*.ninja

#################
## Eclipse
#################

*.pydevproject
.project
.metadata
#bin/**
tmp/**
tmp/**/*
*.tmp
*.bak
*.swp
*~.nib
local.properties
.classpath
.settings/
.loadpath

# External tool builders
.externalToolBuilders/

# Locally stored "Eclipse launch configurations"
*.launch

# CDT-specific
.cproject

# PDT-specific
.buildpath


#################
## Visual Studio
#################

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.sln.docstates

# Build results
**/[Dd]ebug/
**/[Rr]elease/
*_i.c
*_p.c
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.vspscc
.builds
**/*.dotCover

## TODO: If you have NuGet Package Restore enabled, uncomment this
#**/packages/

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf

# Visual Studio profiler
*.psess
*.vsp

# ReSharper is a .NET coding add-in
_ReSharper*

# Installshield output folder
[Ee]xpress

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish

# Others
#[Bb]in
[Oo]bj
sql
TestResults
*.Cache
ClientBin
stylecop.*
~$*
*.dbmdl
Generated_Code #added for RIA/Silverlight projects

# Backup & report files from converting an old project file to a newer
# Visual Studio version. Backup files are not needed, because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML


############
## Windows
############

# Windows image file caches
Thumbs.db

# Folder config file
Desktop.ini


#############
## Python
#############

*.py[co]

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
#bin
var
sdist
develop-eggs
.installed.cfg

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox

#Translations
*.mo

#Mr Developer
.mr.developer.cfg

# Mac crap
.DS_Store
*.dylib
*.a

############
## Xcode
############

*.pbxproj
xcschemes
*.xcuserstate
*.xcsettings
*.xcworkspacedata
*.xcuserdatad
*Instruments.trace*

bin/
lib/

build*/ # user build directory
15 changes: 12 additions & 3 deletions LICENSE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,17 @@ MIT License
- Copyright (C) 2012 Garry Newman
- Copyright (C) 2015-2016 Bill Quith

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:
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 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.
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.
16 changes: 8 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ your platform. Only have one renderer per build directory. Choose renderer:
* `-DRENDER_SDL2=ON`
* `-DRENDER_SFML2=ON`

For example to build SDL2 renderer using Ninja:
For example to build Allegro 5 renderer using Ninja:

```bash
cd gwork
mkdir build && cd build # put all build files in separate directory
cmake -GNinja -DRENDER_ALLEGRO5=ON .. # create Ninja project files with SDL2 renderer
mkdir build && cd build # put build files in subdirectory
cmake -GNinja -DRENDER_ALLEGRO5=ON .. # create Ninja project files
```

Providing the dependencies are present, this will create a sample executable. When run it will
Expand All @@ -51,7 +51,6 @@ bin/GworkAllegro5Sample # run sample
* CMake is used to generate project files instead of Premake. CMake is much more
comprehensive.
* [SDL2][sdl2] renderer added.
* C++11 used.
* [UTF-8 everywhere][5]. Unicode support simplified.
* `Gwen::UnicodeString` removed. This assumed that all Unicode was best as a
wide encoding. This is not the case on all platforms.
Expand All @@ -61,6 +60,7 @@ bin/GworkAllegro5Sample # run sample
* Documentation:
* Any existing GWEN comments and docs formatted for [doxygen](http://doxygen.org).
* Docs currently very minimal as GWEN has almost no documentation.
* C++11 used.
* Cache to texture optimisation implemented (Allegro only).
* No dependency on Bootil (Garry's personal library).
* Fixes for [Allegro][al5]. e.g. text rendering.
Expand All @@ -74,21 +74,21 @@ bin/GworkAllegro5Sample # run sample
Github, Google Code, etc use 8 space tabs. GWEN uses 4 space tabs. This
messes up the indentation when reading code on Github.
* Brackets: [Allman][2]/BSD indentation.
* Line length ~100 chars. Github has width around 100. Easier for
3 way merge. Everything on regular screen.
* Line length ~100 chars. Github has width around 100. Easier for 3 way merge. Everything
on regular screen.
* camelCase variables.

Please [report problems to Github][7] or they'll get lost.
Please [report problems to Github][issues] or they'll get lost.

BQ

[gwen]: https://github.com/garrynewman/GWEN
[sdl2]: https://www.libsdl.org/
[sfml2]: http://www.sfml-dev.org
[al5]: http://alleg.sourceforge.net
[issues]: https://github.com/billyquith/GWork/issues "Bugs/Issues"
[1]: http://www.codinghorror.com/blog/2009/04/death-to-the-space-infidels.html "Interesting article on consistency"
[2]: http://en.wikipedia.org/wiki/Indent_style#Allman_style "Not uncommon"
[5]: http://www.utf8everywhere.org "Why you should use UTF8 everywhere."
[6]: http://industriousone.com/premake
[7]: https://github.com/billyquith/GWork/issues "Bugs/Issues"

0 comments on commit 5f461bd

Please sign in to comment.