Java-Gaming.org    
Featured games (81)
games approved by the League of Dukes
Games in Showcase (497)
Games in Android Showcase (114)
games submitted by our members
Games in WIP (563)
games currently in development
News: Read the Java Gaming Resources, or peek at the official Java tutorials
 
    Home     Help   Search   Login   Register   
Pages: [1]
  ignore  |  Print  
  Uploading a project to Git, readme file?  (Read 528 times)
0 Members and 1 Guest are viewing this topic.
Offline P0jahn

Senior Member


Projects: 3



« Posted 2014-02-25 19:37:53 »

I read somewhere that whenever someone upload a project to Github, they should always include a readme file, for legal reasons.

What should this readme file say? I dont know much about laws. My project is 100% free and open-source. I use Slick2d(along with LWJGL) and TinySound, the rest have I code myself.

Should I be worried that some douche may sue me?
Offline Gibbo3771
« Reply #1 - Posted 2014-02-25 19:53:12 »

I read somewhere that whenever someone upload a project to Github, they should always include a readme file, for legal reasons.

What should this readme file say? I dont know much about laws. My project is 100% free and open-source. I use Slick2d(along with LWJGL) and TinySound, the rest have I code myself.

Should I be worried that some douche may sue me?

You include the author, date released, the copyright information (in your case, it would be open source so there isn't really anything to say here, just say so). Give credits where it is owned, might be nice to say what you use, for me I would thank the LibGDX creator, Box2D creator and any free art I use.

Also include a small description.


"This code works flawlessly first time and exactly how I wanted it"
Said no programmer ever
Offline P0jahn

Senior Member


Projects: 3



« Reply #2 - Posted 2014-02-25 20:06:28 »

Thanks. I assume by "small description", you mean a description about what my projet is?
Games published by our own members! Check 'em out!
Legends of Yore - The Casual Retro Roguelike
Offline BurntPizza
« Reply #3 - Posted 2014-02-25 20:27:27 »

A readme on Github is a bit different than a regular legal or instructional notice, at least IMO. It usually includes those things, though.

The readme is the 'front page' of your project on Github, such as here, beginning with the libGDX logo. It gives general information for your project, and links to get more detailed info, such as a project wiki.
Offline tom_mai78101
« Reply #4 - Posted 2014-02-26 02:50:54 »

I read somewhere that whenever someone upload a project to Github, they should always include a readme file, for legal reasons.

That would be a license, not a readme. GitHub actually provides you a selection of licenses you can choose when you create your repository.

Since you said your project is 100% free and open-source, you can either consider GPL licenses, the Apache License, or the Creative Commons license.

GPL licenses require you to put the licenses everywhere if you continue with the project.
Apache License is what most of us GitHub project creators use.
Creative Commons is like what the Wikipedia does, sharing information without saying who the author(s) is.
Offline P0jahn

Senior Member


Projects: 3



« Reply #5 - Posted 2014-02-26 17:42:06 »

Thanks for the answers.

I have an other related question, resources.

Should I commit resources(images, sound effects and music) as well? Note that most resources used in my project are taken from games/movies etc. Could I get in trouble for that?
Offline jonjava
« Reply #6 - Posted 2014-02-26 17:46:30 »

Make a private repo at bitbucket.

Offline P0jahn

Senior Member


Projects: 3



« Reply #7 - Posted 2014-03-02 16:43:38 »

So it would be dangerous to upload resources?
Offline lolzballs

Junior Newbie


Exp: 2 years



« Reply #8 - Posted 2014-03-04 01:41:41 »

So it would be dangerous to upload resources?
Uploading a resource that is not made by you is illegal, unless you have permission/license allows.
Pages: [1]
  ignore  |  Print  
 
 
You cannot reply to this message, because it is very, very old.

 

Add your game by posting it in the WIP section,
or publish it in Showcase.

The first screenshot will be displayed as a thumbnail.

BurntPizza (22 views)
2014-09-19 03:14:18

Dwinin (35 views)
2014-09-12 09:08:26

Norakomi (62 views)
2014-09-10 13:57:51

TehJavaDev (88 views)
2014-09-10 06:39:09

Tekkerue (43 views)
2014-09-09 02:24:56

mitcheeb (65 views)
2014-09-08 06:06:29

BurntPizza (47 views)
2014-09-07 01:13:42

Longarmx (35 views)
2014-09-07 01:12:14

Longarmx (40 views)
2014-09-07 01:11:22

Longarmx (36 views)
2014-09-07 01:10:19
List of Learning Resources
by Longor1996
2014-08-16 10:40:00

List of Learning Resources
by SilverTiger
2014-08-05 19:33:27

Resources for WIP games
by CogWheelz
2014-08-01 16:20:17

Resources for WIP games
by CogWheelz
2014-08-01 16:19:50

List of Learning Resources
by SilverTiger
2014-07-31 16:29:50

List of Learning Resources
by SilverTiger
2014-07-31 16:26:06

List of Learning Resources
by SilverTiger
2014-07-31 11:54:12

HotSpot Options
by dleskov
2014-07-08 01:59:08
java-gaming.org is not responsible for the content posted by its members, including references to external websites, and other references that may or may not have a relation with our primarily gaming and game production oriented community. inquiries and complaints can be sent via email to the info‑account of the company managing the website of java‑gaming.org
Powered by MySQL Powered by PHP Powered by SMF 1.1.18 | SMF © 2013, Simple Machines | Managed by Enhanced Four Valid XHTML 1.0! Valid CSS!