├── .gitignore ├── git-basics ├── images │ ├── fork.png │ ├── new-repo.png │ ├── forked-repo.png │ ├── clone-download-url.png │ └── copy-url-from-new.png └── README.md ├── README.md ├── python2vs3 └── README.md ├── python-turtles └── README.md ├── exceptions-best-practices └── README.md ├── beyond-lc101-java-stl └── README.md ├── spring-persistence └── README.md ├── thymeleaf └── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | -------------------------------------------------------------------------------- /git-basics/images/fork.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LaunchCodeEducation/cheatsheets/HEAD/git-basics/images/fork.png -------------------------------------------------------------------------------- /git-basics/images/new-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LaunchCodeEducation/cheatsheets/HEAD/git-basics/images/new-repo.png -------------------------------------------------------------------------------- /git-basics/images/forked-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LaunchCodeEducation/cheatsheets/HEAD/git-basics/images/forked-repo.png -------------------------------------------------------------------------------- /git-basics/images/clone-download-url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LaunchCodeEducation/cheatsheets/HEAD/git-basics/images/clone-download-url.png -------------------------------------------------------------------------------- /git-basics/images/copy-url-from-new.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LaunchCodeEducation/cheatsheets/HEAD/git-basics/images/copy-url-from-new.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cheatsheets 2 | 3 | A collection of cheatsheets used in LaunchCode Education programs 4 | 5 | - [Spring Persistence](spring-persistence/README.md) 6 | - [Thymeleaf Templates](thymeleaf/README.md) 7 | - [Python 2 vs. 3](python2vs3/README.md) 8 | - [Git Basics](git-basics/README.md) 9 | - [Exceptions Best Practices](exceptions-best-practices/README.md) 10 | -------------------------------------------------------------------------------- /python2vs3/README.md: -------------------------------------------------------------------------------- 1 | # Python 2 versus Python 3 2 | 3 | The most prominent differences between Python 2 and Python 3 are presented here. Thankfully, they're relatively easy to get used to. If you're curious about the other differences, [Sebastian Raschka's article](http://sebastianraschka.com/Articles/2014_python_2_3_key_diff.html) on the topic lays them out nicely. 4 | 5 | ## Using `print` 6 | 7 | In Python 2, `print` is a statement, while in Python 3, `print` is a function. Practically, this means that in Python 2 you can do things like: 8 | 9 | ```python 10 | # using Python 2 11 | print "Hello, World!" 12 | print "LaunchCode", "is great" 13 | ``` 14 | Output: 15 | ``` 16 | Hello, World! 17 | LaunchCode is great 18 | ``` 19 | In Python 3, the equivalent code would be 20 | ```python 21 | # using Python 3 22 | print("Hello, World!") 23 | print("LaunchCode", "is great") 24 | ``` 25 | For most intents and purposes, you can see that Python 2 print statements don't use parentheses, but Python 3 print statements do. That said, you can do the following in Python 2: 26 | ```python 27 | # using Python 2 28 | print("Hello, World!") 29 | print("LaunchCode", "is great") 30 | ``` 31 | with output: 32 | ``` 33 | Hello, World! 34 | (LaunchCode, is great) 35 | ``` 36 | Hence, Python 2 will accept print statements with parentheses, but with potentially unexpected output. Conversely, if you try to use `print` without parentheses in Python 3, you'll get a syntax error. 37 | 38 | ```python 39 | # using Python 3 40 | print "please print me" 41 | ``` 42 | Output: 43 | ``` 44 | File "", line 1 45 | print "please print me" 46 | ^ 47 | SyntaxError: Missing parentheses in call to 'print' 48 | ``` 49 | 50 | ## Prompting for input 51 | 52 | In Python 3, you've used the `input` function to prompt for user input. 53 | 54 | ```python 55 | # using Python 3 56 | name = input("What's your name? ") # name is a string 57 | age = input("How old are you? ") # age is a string 58 | ``` 59 | 60 | In Python 2, to get the same behavior we have to use the `raw_input` function. 61 | 62 | ```python 63 | # using Python 2 64 | name = raw_input("What's your name? ") # name is a string 65 | age = raw_input("How old are you? ") # age is a string 66 | ``` 67 | 68 | `input` is available as a function in Python 2, but it behaves differently than in Python 3. For more details, see the article linked above. 69 | -------------------------------------------------------------------------------- /python-turtles/README.md: -------------------------------------------------------------------------------- 1 | # Python Turtles 2 | 3 | This cheatsheet is a condensed and more accessible version of the official documentation for [Python's `turtle` module](https://docs.python.org/3.5/library/turtle.html) (for Python 3). 4 | 5 | ## The `turtle` Module 6 | 7 | ### Importing the Module 8 | 9 | The import must always be the first line of your program. 10 | 11 | ```python 12 | import turtle 13 | ``` 14 | 15 | ### Creating a Turtle 16 | 17 | Create a new turtle and store it in a variable (using whichever name you choose): 18 | 19 | ```python 20 | import turtle 21 | 22 | jim = turtle.Turtle() 23 | ``` 24 | 25 | It is also possible to create multiple turtles within the same program: 26 | 27 | ```python 28 | import turtle 29 | 30 | jim = turtle.Turtle() 31 | jane = turtle.Turtle() 32 | ``` 33 | 34 | > NOTE: The rest of the examples shown below assume that you have imported and created a turtle named `speedy` 35 | 36 | ## Moving a Turtle 37 | 38 | Here are common commands for moving a turtle around a screen. While the examples give use specific values, you can use any other value that makes sense. 39 | 40 | Command | Value/Parameter | Example | Description 41 | --- | --- | --- | --- 42 | `forward` | # of units | `speedy.forward(50)` | Move forward 50 units 43 | `backward` | # of units to move | `speedy.backward(50)` | Move backward 50 units 44 | `left` | # degrees to turn | `speedy.left(45)` | Turn left 45 degrees 45 | `right` | # degrees to turn | `speedy.right(45)` | Turn right 45 degrees 46 | `goto` | coordinates of destination | `speedy.goto(25, 50)` | Move to the point (25, 50) 47 | `speed` | `1...10` | `speedy.speed(5)` | Sets the speed of the turtle's motion to 5. The speed can be 1 through 10, with 1 being the slowest and 10 the fastest. 48 | 49 | ## Styling a Turtle Drawing 50 | 51 | Here are common commands for controlling how a turtles uses its pen to draw images. While the examples give use specific values, you can use any other value that makes sense. 52 | 53 | Command | Value/Parameter | Example | Description 54 | --- | --- | --- | --- 55 | `up` | (none) | `speedy.up()` | Pick up the turtle's pen, do it doesn't draw a line as the turtle moves 56 | `down` | (none) | `speedy.down()` | Put down the turtle's pen, so it draws a line as the turtle moves 57 | `pencolor` | color name | `speedy.pencolor("blue")` | Use a blue pen. See below for valid colors. 58 | `fillcolor` | color name | `speedy.fillcolor("red")` | Fill the shape with the color red. See below for valid colors. 59 | `begin_fill` | (none) | `speedy.begin_fill()` | Marks the current position as the beginning of a shape that is to be filled with the fill color. 60 | `end_fill` | (none) | `speedy.end_fill()` | Marks the current position as the end of a shape that is to be filled with the fill color. When you use this command, the shape will actually be filled. 61 | `dot` | (none) | `speedy.dot()` | Marks a dot shape at the current position, in the pen's color. 62 | `shape` | shape name | `speedy.shape("turtle")` | Change the shape of the turtle on the screen to the given shape. Valid values are "arrow", "turtle", "circle", "square", "triangle", "classic". 63 | `stamp` | (none) | `speedy.stamp()` | Mark a shaped "stamp" at the current position. This works like `speedy.dot()` except that it uses the shape of the turtle set using the `shape` command. 64 | 65 | > Valid color names include those named on [this page](https://www.tcl.tk/man/tcl8.4/TkCmd/colors.htm). Note that the color names ending in a number (e.g. "azure1") do *not* work. If you use an invalid color, you will either receive an error message, or the color will be set to black, depending on the situation. 66 | -------------------------------------------------------------------------------- /exceptions-best-practices/README.md: -------------------------------------------------------------------------------- 1 | Exceptions Best Practices 2 | ================================ 3 | 4 | This document is agnostic of programming language, but you should be familiar with the concept of exceptions in the language you're working with. 5 | 6 | If you're not, good resources exist elsewhere, including for [Java](https://docs.oracle.com/javase/tutorial/essential/exceptions/) and [C#](https://msdn.microsoft.com/en-us/library/ms173160.aspx). 7 | 8 | ## Common Causes of Exceptions 9 | 10 | - Failure to connect to services external to your application, such as a database or API. 11 | - Failure to read/write from/to a file. 12 | - Failed attempt to convert data, such as trying to convert something like `"dog"` to an integer. This happens most often when accepting user input. 13 | - Null pointers. In other words, an object reference -- such as a method parameter or local variable -- that doesn't actually contain an object. 14 | 15 | ## Best Practices 16 | 17 | ## The Golden Rules of Handling Exceptions 18 | 19 | From *Foundations of Programming* by Karl Seguin ([online version](http://openmymind.net/FoundationsOfProgramming.pdf)): 20 | 21 | 1. Only handle exceptions that you can actually do something about. 22 | 2. You can't do anything about the vast majority of exceptions. 23 | 24 | For example, if your code receives an exception due to a database not being available, there's probably nothing your program can do about it. 25 | 26 | However, if you receive invalid input from a user, you would be able to re-prompt them, along with an error message to help them get it right the next time. 27 | 28 | ## Which Types to Catch 29 | 30 | When working with a try/catch statement, in statically-type languages you can declare the type of exception you wish to catch. Given inheritance and polymorphism, catching the base `Exception` type will result in *all* exceptions being caught. This is a bad thing to do. 31 | 32 | How is it possible for you, as the programmer, to be able to anticipate every possible exception that might be thrown? And further, how could you reasonably be able to handle every type of exception? You probably can't. Be specific about the types of exceptions you want to catch, and your code will be much better. 33 | 34 | Catching the base class `Exception` -- that is, all exceptions -- is sometimes referred to as "exception swallowing" since in most cases, these exceptions are simply absorbed and not re-thrown or logged. If your program has a bug, or reaches an undesirable state, you want to know about it! **Don't swallow exceptions.** 35 | 36 | ## Which Types to Throw 37 | 38 | As with catching, be specific with which types of exceptions you throw. **Never throw an instance of the base `Exception` class.** If a built-in exception type works well based on it's documented intended use, then use it! However, if there isn't a built-in exception that's appropriate, or if it's possible to provide more helpful information by using a custom exception class, then do so. 39 | 40 | ## How to Avoid Exceptions 41 | 42 | For some types of exceptions, there's little you can do. If a database goes down, it's down. However, many situations that result in exceptions are avoidable. 43 | 44 | ### Validate User Input 45 | 46 | Validate user input to ensure that it is of the type your code expects, and satisfies any other implicit constraints (such as numeric input falling within a certain range). 47 | 48 | If you're working within a framework such as ASP.NET or Spring Boot, use the built-in validation capabilities to make this easier. 49 | 50 | Perhaps the most important thing to keep in mind here is that you should **never assume that input given to your program is safe and valid**. This is the case even when you're providing browser-based validation. Clever (or malicious) users can bypass most forms of client-side validation. 51 | 52 | ### Check For `null` References 53 | 54 | If your code depends on an input parameter not being `null` to work properly, and it's possible to gracefully handle the situation -- for example, by re-prompting the user -- then you should do so. 55 | 56 | As with exceptions above, if there is no way to reasonably recover from a null pointer, then you shouldn't "swallow" it. Furthermore, it's generally a bad idea to catch a null pointer exception (`NullPointerException` in Java, `NullReferenceException` in C#). [Read more](http://stackoverflow.com/questions/5991745/java-null-reference-best-practice) on why this is the case. 57 | 58 | 59 | ## References 60 | 61 | ### C# 62 | 63 | - [Exceptions and Exception Handling](https://msdn.microsoft.com/en-us/library/ms173160.aspx) 64 | - [Exception Hierarchy](https://msdn.microsoft.com/en-us/library/z4c5tckx.aspx) 65 | 66 | ### Java 67 | 68 | - [Exceptions Tutorial](https://docs.oracle.com/javase/tutorial/essential/exceptions/) 69 | - [Effective Java Exceptions](http://www.oracle.com/technetwork/articles/entarch/effective-exceptions-092345.html) 70 | - [Class Exception](http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) 71 | -------------------------------------------------------------------------------- /beyond-lc101-java-stl/README.md: -------------------------------------------------------------------------------- 1 | # Beyond LC101 - Java 2 | 3 | This cheat sheet is a collection of links and resources you may find helpful as you continue your LaunchCode process and your career. 4 | 5 | ## Resources 6 | 7 | ### Great Java Blogs 8 | 9 | [Vogella](http://www.vogella.com/tutorials/java.html) 10 | 11 | [Mkyong](https://www.mkyong.com/) 12 | 13 | [DZone](https://dzone.com/java-jdk-development-tutorials-tools-news) 14 | 15 | ### Spring Tutorials 16 | 17 | Protip: As you scour the edges of the internet in search of tutorials and answers, beware of dated documentation, especially around Spring. A good rule of thumb, is if you see XML configuring Spring, it's probably not what you're looking for. 18 | 19 | [Spring.io](http://spring.io/guides) A great way to learn about other tools built into Spring Boot. Interesting additional topics include building and consuming REST services, accessing FB data, and Spring Security. At the bottom, you'll find more complete tutorials that dig in deeper to topics like REST architecture, Security with OAuth2 (i.e. FB login), as well as integrating with front end frameworks like React and Angular. 20 | 21 | ### Testing 22 | 23 | [Unit and Integration Tests](https://dzone.com/articles/unit-and-integration-tests-in-spring-boot) Writing tests for your applications have countless benefits. It's much quicker to write a unit test around functionality than it is to start up your web server, setup your data, and manually test functionality. As an added bonus, tests act as a great indicator that you might have broken unrelated functionality. 24 | 25 | [Test Driven Development](http://agiledata.org/essays/tdd.html) Tests are _so_ beneficial, that many believe you should write your tests first. TDD helps you define how your functionality behaves before you start coding it. 26 | 27 | ### Front End 28 | 29 | [Bootstrap](http://getbootstrap.com/) If you're interested in making your Thymeleaf project mobile friendly, Bootstrap can provide the framework necessary to make sure your web app looks great on mobile too! Bootstrap is also used by many other front end languages and templating frameworks, so it's a portable skill that can give your web app that extra pop! 30 | 31 | [jQuery](https://jquery.com/) jQuery is a great, all-purpose JavaScript library to either supplement Thymeleaf, or build your own front end. 32 | 33 | [Spring Boot and jQuery](https://spring.io/guides/gs/spring-boot-cli-and-js/) 34 | 35 | ### Cloud 36 | 37 | [Cloud Foundry](https://pivotal.io/platform/pcf-tutorials/getting-started-with-pivotal-cloud-foundry/introduction) Learn how to run your apps with Cloud Foundry, hosted by Pivotal Web Services. Cloud Foundry can be used in many environments, including AWS and Azure, but Pivotal is fastest way to get your projects hosted. 38 | 39 | ## Stay Connected 40 | 41 | [LaunchCode Slack](https://launchcode-community.herokuapp.com/) Stay connected with LaunchCode post LC101. Share articles and resources. Ask questions. Look at cat pictures! 42 | 43 | [StlTech Slack](https://stltech.herokuapp.com/) St. Louis Tech's largest Slack community. Network! Find a meetup! Argue over tabs vs spaces! 44 | 45 | [Meetup.com](www.foo.com) Most area tech meetups are advertised on Meetup.com. Be sure to check out these that might be of interest: 46 | 47 | * [St. Louis Java User's Group](https://www.meetup.com/GatewayJUG/) Come for the presentation, stay for the door prizes! 48 | * [St. Louis Full Stack](https://www.meetup.com/SaintLouis_FullStack_WebDevelopment/) Leverage your front end and back end skills. 49 | * [St. Louis Groovy & Grails Meetup](https://www.meetup.com/st-louis-groovy-and-grails-meetup/) Groovy is scripting language (somewhat like Python in some regards) but leverages the power of the JVM and is very accessible for Java developers. Grails is a great tool to help you quickly build apps. 50 | * [St. Louis Machine Learning & Data Science](https://www.meetup.com/St-Louis-Machine-Learning/) 51 | * [DevOps STL](https://www.meetup.com/DevOps-STL/) Use your coding skills to tackle operational concerns and make all the gears turn smoothly. 52 | * [St. Louis Hadoop Users Group](https://www.meetup.com/St-Louis-Hadoop-Users-Group/) 53 | * [St. Louis Deep Learning Meetup](https://www.meetup.com/Saint-Louis-Deep-Learning-Meetup/) 54 | * [St. Louis Postgres User Group](https://www.meetup.com/St-Louis-Postgres-User-Group/) 55 | 56 | 57 | ## Hone Your Skills 58 | 59 | ### Programming Prompts 60 | 61 | [HackerRank](https://www.hackerrank.com/) 62 | 63 | [exercism.io](http://exercism.io/) 64 | 65 | [Project Euler](https://projecteuler.net/) 66 | 67 | ### Great Reads 68 | 69 | [Clean Code](https://smile.amazon.com/dp/0132350882/ref=wl_it_dp_o_pd_nS_ttl?_encoding=UTF8&colid=1RLJ633KTNB8F&coliid=I3CB117REXGCVA) Now that you know how to code, learn how to code well. 70 | 71 | [The Pragmatic Programmer](https://smile.amazon.com/dp/020161622X/ref=wl_it_dp_o_pC_nS_ttl?_encoding=UTF8&colid=1RLJ633KTNB8F&coliid=ILKBPVXKAL1S5) How to become a great software developer, not just a coder. 72 | 73 | [Head First Design Patterns](https://smile.amazon.com/Head-First-Design-Patterns-Brain-Friendly/dp/0596007124/ref=sr_1_1?s=books&ie=UTF8&qid=1492049981&sr=1-1&keywords=head+first+design+patterns) The Head First series excel at making the topic accessible. In Design Patterns, you'll learn about re-usable and efficient patterns you can use to solve problems without reinventing the wheel. 74 | 75 | [Cracking the Coding Interview](https://smile.amazon.com/dp/0984782850/ref=rdr_ext_tmb) 76 | 77 | ### Soft Skills 78 | 79 | [Rubber Duck Debugging](https://rubberduckdebugging.com/) Working without the help of TFs and classmates can be intimidating. Grab a rubber duck, and be amazed at the fact that YOU'VE GOT THIS! Having to actually explain what your code does (out loud!) forces you to understand what your code is doing, and you'd be surprised at how effective this is at helping you catch your mistakes. 80 | 81 | [Pair Programming](https://www.thoughtworks.com/insights/blog/effective-navigation-in-pair-programming) Learn some great practices for 'pairing up' with a peer. 82 | 83 | [Scrum](https://www.youtube.com/watch?v=TRcReyRYIMg) Many shops utilize some form of 'Agile' development to quickly build and iterate projects. Scrum is one such implementation of this. Learning how to identify a Minimal Viable Product (MVP) and how to break down large goals into smaller manageable tasks is a great skill to master for both professional, and personal projects. 84 | -------------------------------------------------------------------------------- /spring-persistence/README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot Persistence Cheat Sheet 2 | 3 | This cheat sheet is broadly applicable, but assumes that you're using MySQL 5.x, Spring Boot, and Gradle. 4 | 5 | ## Using MySQL 6 | 7 | Using a local MySQL database will allow your data to persist between application shutdown and startup. An easy way to install MySQL on Mac and Windows is via [MAMP](https://www.mamp.info/en/). 8 | 9 | ### Dependencies 10 | 11 | Add the following to the `dependencies` section of your `build.gradle`: 12 | ```nohighlight 13 | compile('org.springframework.boot:spring-boot-starter-data-jpa') 14 | compile('mysql:mysql-connector-java') 15 | ``` 16 | 17 | The `spring-boot-starter-data-jpa` artifact includes the Hibernate ORM framework. We won't talk explicitly about Hibernate since we won't need to work with it directly in most situations. We'll primarily work with Java Persistence API annotations, but you should know that Hibernate provides the implementation for most of these behaviors behind the scenes. 18 | 19 | ### `application.properties` 20 | 21 | The database connection needs to be configured via `src/main/resources/application.properties`. 22 | 23 | These properties use `property=value` syntax. For many, there are alternative values listed in the Spring documentation, but these are good for most purposes. The database user specified should have all privileges on the given database. 24 | 25 | `spring.datasource.url` - of the form `jdbc:mysql://localhost:8889/db` for a local database `db` on the default MySQL port 8889 26 | 27 | `spring.datasource.username` - Username to use when connecting to the db 28 | 29 | `spring.datasource.password` - Password to use when connecting to the db 30 | 31 | `spring.jpa.database = MYSQL` - specifies that you'll be using a MySQL database 32 | 33 | `spring.jpa.hibernate.ddl-auto = update` - Spring should attempt to update the database schema upon restart to reflect any changes to persistent model classes 34 | 35 | `spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect` - Specifies that we're using MySQL 5.x 36 | 37 | The database engine must be running when you start up your application. 38 | 39 | ## Java Persistence API (JPA) 40 | 41 | ### Class Annotations 42 | 43 | `@Entity` - Required for Hibernate to store/retrieve instances of the class to/from the database. Every field of the class not marked `@Transient` will be stored in the database (see below for more on `@Transient`). 44 | 45 | `@Transactional` - Most often used on `CrudRepository` interfaces. Specifies that if any data operation within the class throws a runtime exception, all associated database queries should be rolled back (that is, undone). This can prevent data corruption caused by exceptions. 46 | 47 | `@Table` - *Optional*. Specifies the name of the table in the given database used to store the objects properties. If omitted, the table name is generated via the default rules. 48 | 49 | ### Setting up your class 50 | 51 | Each persistent class -- that is, each class that you want to be managed by Hibernate and stored in the database -- needs to follow a couple of important rules. These rules will allow Hibernate to properly create objects when pulling data from the database. If you don't follow these rules, you'll see Hibernate-related exceptions upon starting your application. 52 | 53 | ### No-arg constructor 54 | 55 | **Every Hibernate-managed class needs a public constructor that takes no arguments** (aka a "no-arg constructor"). For example, if we're dealing with a class named `User` then it should have a constructor that looks like: 56 | ```java 57 | public User() {} 58 | ``` 59 | This allows Hibernate to create a new instance of your object, no matter what properties it may have. Instance properties won't be initialized by this constructor, obviously, which is why we need the next rule. 60 | 61 | ### Field Annotations 62 | 63 | These annotations are applicable within a class annotated by `@Entity`. They determine how class fields are persisted in a database. 64 | 65 | These annotations can, in most cases, be applied to fields directly, but they can also be applied to getter methods. We recommend applying them to fields. Doing so means you don't have to expose a public setter for the given property, which can break encapsulation (think of an `id` field with a public setter...not good). [Read about][field-vs-property] how these two approaches are different, and why you might choose one over the other. 66 | 67 | `@NotNull` - This is not actually a JPA annotation -- it is part of the `javax.validation.constraints` package -- but Hibernate enforces it as well. Specifies that the field may not be null. 68 | 69 | `@Column` - Specifies the name of the column in the given table used to store the field. If omitted, the column name is generated via the configured or default naming convention. There are several attributes -- such as `nullable` and `unique` -- that result in database-level restrictions being applied (i.e. in database constraints rather than Hibernate constraints). 70 | 71 | *Note*: `@NotNull` and `nullable = false` have similar but slightly different effects. [Read more](http://stackoverflow.com/questions/7439504/confusion-notnull-vs-columnnullable-false) about how they differ. 72 | 73 | `@Id` - The field should be considered an identifier for the class. In particular, the corresponding column in the database should be a primary key. A field with this annotation must one of: a primitive type, a primitive wrapper type (e.g. `Integer` or `Float`), `String`, `java.util.Date`, or a few others (see documentation link below). 74 | 75 | `@GeneratedValue` - Specifies that the field should be generated by Hibernate. This annotation can be configured to use different value generation strategies. 76 | 77 | `@OneToMany` - Specifies a field that is a collection of other persistent objects. 78 | 79 | `@ManyToOne` - The inverse (or "other side") of the `@OneToMany` annotation. This is used within a class that is "owned" by another class, to annotate a field that points back to the "owner". For example, with `Item` and `Category` classes (where `Item` is contained in a `Category`, that is, a `Category` has many `Item` objects), the `Item` class can have a `category` field that points to the object that owns it. 80 | 81 | `@JoinColumn` - Typically used in conjunction with `@OneToMany`, this annotation specifies the column on the "owned" object's table that should be used to identify it's owner. In the `Item`/`Category` example, the value of the `category_id` column specifies the `id` of the `Category` that owns the `Item`. 82 | 83 | `@Transient` - Specifies that Hibernate *should not* store the field in the database. 84 | 85 | ## Additional References 86 | 87 | - [Spring Data JPA Reference](http://docs.spring.io/spring-data/jpa/docs/current/reference/html/) 88 | - [Object Relational Mapping (ORM) in Spring](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/orm.html) 89 | - [JPA Annotation Reference](http://www.objectdb.com/api/java/jpa/annotations) 90 | 91 | [field-vs-property]: http://stackoverflow.com/questions/594597/hibernate-annotations-which-is-better-field-or-property-access 92 | -------------------------------------------------------------------------------- /thymeleaf/README.md: -------------------------------------------------------------------------------- 1 | Thymeleaf cheat sheet 2 | ===================== 3 | 4 | This is a cheat sheet to summarize all the main Thymeleaf features and how to use them to kickstart you with Thymeleaf. 5 | 6 | ## What is Thymeleaf? 7 | 8 | 9 | Thymeleaf is an engine that builds dynamic pages from templates that are written in XHTML with the help of some special attributes, so it is a **template engine**. 10 | 11 | A template engine is an engine that parses XHTML/HTML pages that contain special tags or attributes or syntax that is bound to variables at the server, and resolves them into their values, then parses the page according to those values and builds a normal HTML page. 12 | 13 | Thymeleaf is an **in-memory** template engine, so it does all of it's processing in memory, it builds a DOM that maps to the HTML of the page in-memory and when values change the parsed pages are changed, also it's caching is an in-memory caching system. 14 | 15 | Thymeleaf is a template engine that relays mostly on **attributes** instead of tags like what JSP would do, this makes it testable in the browser directly without requiring a server. 16 | 17 | Those attributes are then translated and processed by Thymeleaf into normal HTML. 18 | 19 | ## How it works 20 | 21 | ```html 22 |

text

23 | ``` 24 | 25 | Here Thymeleaf will process the text inside the `th:text` attribute, and replace the contents of the `

` tag with it. 26 | 27 | We can use **variable expressions** syntax `${...}` to insert data passed in from a controller. 28 | 29 | ```html 30 |

text

31 | ``` 32 | 33 | Thymeleaf works by replacing the contents of the tags that it's attributes are defined on. Another example is: 34 | 35 | ```html 36 | 37 | Onions 38 | 2.41 39 | 40 | ``` 41 | 42 | Here Thymeleaf will repeat the `` with the list of products, this is defined by the attribute `th:each`, it will also remove the dummy content in both the `` tags, and replace them with the content that is evaluated from `th:text="${prod.name}"` and `th:text="${prod.price}"`. 43 | 44 | ## Attributes 45 | 46 | Thymeleaf is an attribute based template engine, it processes attributes and their values to build it's DOM tree. 47 | 48 | * `th:text`: this attribute is responsible for displaying text that is evaluated from the expression inside it, it will process the expression and then display the text **html-encoded**, 49 | Example: 50 | 51 | ```html 52 |

Welcome to our grocery store!

53 | ``` 54 | 55 | * `th:utext`: Similar to previous attribute but this one display text **unescaped** for more information check [using_texts](http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#using-texts) 56 | * `th:attr` : Takes an HTML attribute and sets it's value dynamically, example: ' 57 | `` 58 | The `value` attribute will be set to the value of `${subscribe.submit}` after processing, replacing the supplied `value="Subscribe me!"` 59 | * `th:value`,`th:action`,`th:href, th:onclick`...etc: Those attributes can be used as a shorthand of the `th:attr` syntax as equally equivalent to it, so the attribute `th:action` is equal to `th:attr="action="` 60 | * `th:attrappend`: This will not replace the attribute value, but will only append the value to it, example: `th:attrappend="class=${' ' + cssStyle}"`, for more information check [setting_attribute_values](http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#setting-attribute-values) 61 | * `th:each`: This is the iteration attribute, it is analogous to Java's for-each loop: `for(Object o : list)`, but its syntax is 62 | 63 | ```html 64 | 65 | Onions 66 | 2.41 67 | yes 68 | 69 | ``` 70 | 71 | The `th:each="prod,iterStat : ${prods}"` is equivalent to `for(Product prod : prods)` and the `iterStat` is the status variable of the iteration, it contains information about current iteration like its number,index,total count ...etc. 72 | 73 | The iteration object `prod` can then be accessed in the context of the tag ``, meaning it will only exist within the tag that it's been defined in, for more information check [iteration](http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#iteration) 74 | 75 | When iterating over a map, the components of each item can be accessed using `.key` and `.value`: 76 | 77 | ```html 78 | 79 | Key 80 | Value 81 | 82 | ``` 83 | 84 | * `th:if`: Evaluates the conditions specified in the attribute and if they are true, the tag is displayed, if not they are not displayed, example : `th:if="${user.admin}"` 85 | * `th:unless`: Is the opposite of `th:if`, it will display the tag if the value is false, so `th:unless="${user.admin}"` is equal to `th:if="${!(user.admin)}"` 86 | * `th:switch` and `th:case`: Those attributes are used to create a swtich statement, `th:switch` will hold the variable to switch on, and `th:case` will evaluate the case statements for this variable, example 87 | 88 | ```html 89 |
90 |

User is an administrator

91 |

User is a manager

92 |

User is some other thing

93 |
94 | ``` 95 | 96 | For more information check [conditional_evaluation](http://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#conditional-evaluation) 97 | 98 | ## Expressions 99 | 100 | Thymeleaf works based on many expressions, Thymeleaf has different expression syntax other than the traditional `${variablename.propertyname}` syntax, namely: 101 | 102 | * `${message.in.proprties.file}` similar to the **i18n** resolver in **JSF**, this expressions will look for the value provided in the localization properties files provided to the application. 103 | Example: `

Brand Name

`, when using spring it will use the `MessageSource` of spring 104 | * `${variable}`: This is the variables expression, if your expression should evaluate to a variable or you have a variable in your `model` as an attribute, you must use this expression to access it, other expressions are used for different purposes and may not functional correctly with variables, example: 105 | `13 february 2011` 106 | 107 | * Thymeleaf provides some predefined variables that can be accessed using the `${#variableName}` syntax and they are: 108 | 109 | 1. `#ctx` : the context object. 110 | 2. `#vars`: the context variables . 111 | 3. `#locale` : the context locale. 112 | 4. `#httpServletRequest` : (only in Web Contexts ) the `HttpServletRequest` object. 113 | 5. `#httpSession`: The session object of current session 114 | 6. `#dates` : utility methods for `java.util.Date` objects : formatting , component extraction, etc. 115 | 7. `#calendars` : analogous to #dates , but for `java.util.Calendar` objects . 116 | 8. `#numbers` : utility methods for formatting numeric objects . 117 | 9. `#strings` : utility methods for String objects : contains , startsWith, prepending /appending , etc. 118 | 10. `#objects` : utility methods for objects in general. 119 | 11. `#bools` : utility methods for boolean evaluation. 120 | 12. `#arrays` : utility methods for arrays . 121 | 13. `#lists` : utility methods for lists . 122 | 14. `#sets` : utility methods for sets . 123 | 124 | Example: 125 | 126 | ```html 127 | 128 | ``` 129 | 130 | and 131 | 132 | ```html 133 | 13 May 2011 134 | ``` 135 | 136 | * `*{property}`: This is used the same way as the `${variable}` but works on selected objects, i.e. objects which are set using `th:object` attribute, for example 137 | 138 | ```html 139 |
140 |

Name: Sebastian.

141 |

Surname: Pepper.

142 |

Nationality: Saturn.

143 |
144 | ``` 145 | 146 | This will access properties on `${session.user}` object directly using the `*{...}` syntax, like for `*{firstName}`, this is equal to using `${session.user.firstName}` 147 | 148 | *Note*: The `th:object` is defined only in the context of the tag it's declared on, meaning it's not available outside the context of that tag. 149 | 150 | * `@{/link/path}`: This will create a link to the path specified relative to the deployment context, so if the application is deployed at context **my-app**, then the generated path will be **/my-app/link/path**. 151 | To include parameters, use `@{/link/path(param=value)}`. This will generate **/link/path?param=value** 152 | For Path variables use: `@{/link/{myPathVariable}/path(myPathVariable=${variable})}` 153 | which will replace the **{myPathVariable}** with the value from **${variable}** 154 | 155 | * Literals: You can also write some normal literals instead of any expressions, 156 | * "'the literal string'": You can write normal strings between two **''** single quotes 157 | * "3 + 2": Normal numeric expressions 158 | * "false","true" and "null": are evaluated to normal `false`,`true` and `null` expressions 159 | * "singleWordToken": tokens with single words do not need single quotes and can be written as is. 160 | * `${#fields}`: Spring MVC adds another predefined variable which is `#fields`, it refers to `spring-form` fields and their validation errors, mainly used for error validation 161 | * `${@beanName.method()}`: Also spring specific bean method call expression, this will call a method on a spring bean called `beanName`, it will look for the bean in the current spring context 162 | -------------------------------------------------------------------------------- /git-basics/README.md: -------------------------------------------------------------------------------- 1 | # Git Basics 2 | 3 | This cheatsheet covers basic commands for creating and working with local and remote Git repositories. 4 | 5 | ## Quick Reference: Basic Workflow 6 | 7 | For most situations, you'll want to use the following basic workflow for git project: 8 | 9 | 1. Make changes to your code 10 | 2. Check status: `$ git status` 11 | 3. Stage changes: `$ git add .` 12 | 4. Commit changes: `$ git commit -m "Added feature X"` 13 | 5. (If working with a remote repository) Push changes: `$ git push origin master` 14 | 15 | The details of these commands, along with the basics of how to get repositories set up, are detailed below. 16 | 17 | This sheet does not cover intermediate topics like branching, fetching, and merging. 18 | 19 | ## Creating a Repository 20 | 21 | How you create your repository depends on whether or not you're starting with an new, empty project or with a pre-existing project from a remote location like GitHub. 22 | 23 | ### Creating a Local Repository: `git init` 24 | 25 | To create an empty local repository for a new project, run the following command from the project directory: 26 | ```nohighlight 27 | $ git init 28 | Initialized empty Git repository in /Users/adalovelace/lc101/new-project/.git/ 29 | ``` 30 | 31 | ### Cloning a Remote Repository from GitHub: `git clone` 32 | 33 | To create a local version of a pre-existing project on GitHub, visit that project's page and copy the **Clone or download** URL. 34 | 35 | Clone or download URL 36 | 37 | > *NOTE:* The project URL is **not** the same as the URL in your browser's address bar, although they are similar. Do not copy the URL from the address bar. Always look for the **Clone or download** button to obtain the project URL. 38 | 39 | Then at a terminal: 40 | ```nohighlight 41 | $ git clone PROJECT_URL 42 | Cloning into 'existing-project'... 43 | remote: Counting objects: 13, done. 44 | remote: Total 13 (delta 0), reused 0 (delta 0), pack-reused 13 45 | Unpacking objects: 100% (13/13), done. 46 | ``` 47 | 48 | ## Check Repository Status: `git status` 49 | 50 | The `status` command of `git` is one of the most commonly-used and most essential. It gives you vital information about the current state of your local repository, including which branch you are currently working on, changes between your local repo and a remote repo, which files are staged for commit, and which changed or new files are not stage or tracked. 51 | 52 | **Use `git status` frequently**, especially before getting ready to carry out a new operation on your repository. Here are a few examples of output: 53 | 54 | **No outstanding changes, not connected to a remote:** 55 | ```nohighlight 56 | $ git status 57 | On branch master 58 | nothing to commit, working tree clean 59 | ``` 60 | 61 | **No outstanding changes, connected to a remote:** 62 | ```nohighlight 63 | $ git status 64 | On branch master 65 | Your branch is up-to-date with 'origin/master'. 66 | nothing to commit, working tree clean 67 | ``` 68 | 69 | **Outstanding changes, connected to a remote:** 70 | ```nohighlight 71 | $ git status 72 | On branch master 73 | Your branch is up-to-date with 'origin/master'. 74 | Changes not staged for commit: 75 | (use "git add ..." to update what will be committed) 76 | (use "git checkout -- ..." to discard changes in working directory) 77 | 78 | modified: README.md 79 | 80 | Untracked files: 81 | (use "git add ..." to include in what will be committed) 82 | 83 | .gitignore 84 | git-basics/ 85 | ``` 86 | 87 | ## Staging Files for Commit: `git add` 88 | 89 | Git keeps track of changes to files within your project, but only if you tell it to. To commit changes to new or existing files, you must first *stage* those files using git's `add` command. 90 | 91 | If you have created a new file, but not staged it, `git status` will show the following: 92 | ```nohighlight 93 | $ git status 94 | On branch master 95 | Untracked files: 96 | (use "git add ..." to include in what will be committed) 97 | 98 | newfile.py 99 | 100 | nothing added to commit but untracked files present (use "git add" to track) 101 | ``` 102 | 103 | To stage the new file for commit: 104 | ```nohighlight 105 | $ git add newfile.py 106 | ``` 107 | 108 | You will see an updated status for the file after staging it: 109 | ```nohighlight 110 | On branch master 111 | Changes to be committed: 112 | (use "git reset HEAD ..." to unstage) 113 | 114 | new file: newfile.py 115 | 116 | ``` 117 | 118 | If you modify a file that has already been added to the repository, it's status will be: 119 | ```nohighlight 120 | $ git status 121 | On branch master 122 | Changes not staged for commit: 123 | (use "git add ..." to update what will be committed) 124 | (use "git checkout -- ..." to discard changes in working directory) 125 | 126 | modified: new.txt 127 | 128 | no changes added to commit (use "git add" and/or "git commit -a") 129 | ``` 130 | 131 | Staging changes for such a file uses the same syntax as for a new file: `$ git add new.txt` 132 | 133 | If you have lots of changes or new files to add, you can add them all at once using: 134 | ```nohighlight 135 | $ git add . 136 | ``` 137 | 138 | > *NOTE:* Before using `git add .` make sure you know what you'll be staging! Run `git status` first. This will save you lots of headaches, and keep you from staging and committing unwanted changes. 139 | 140 | ## Committing Files: `git commit` 141 | 142 | To commit all staged changes to your *local* repository, use git's `commit` command. 143 | ```nohighlight 144 | $ git commit -m "Add amazing new feature" 145 | [master de0d4b6] Add amazing new feature 146 | 2 files changed, 2 insertions(+) 147 | ``` 148 | 149 | The `-m` flag adds a descriptive message, which will help you quickly tell which changes were included in the commit later on. Use concise, descriptive messages! And don't forget to surround your commit message with quotes. 150 | 151 | ## Pushing Files to a Remote Repository: `git push` 152 | 153 | To push all committed changes from your local repository to a remote repository (e.g. a repository on GitHub), use git's `push` command: 154 | 155 | ```nohighlight 156 | $ git push origin master 157 | Counting objects: 4, done. 158 | Delta compression using up to 4 threads. 159 | Compressing objects: 100% (4/4), done. 160 | Writing objects: 100% (4/4), 934 bytes | 0 bytes/s, done. 161 | Total 4 (delta 2), reused 0 (delta 0) 162 | remote: Resolving deltas: 100% (2/2), completed with 2 local objects. 163 | To github.com:LaunchCodeEducation/cheatsheets.git 164 | 73f1872..2926328 master -> master 165 | ``` 166 | 167 | This command can be verbalized as, "Hey, git, push all of my commits to the master branch of the remote repository named 'origin'." This sheet doesn't cover branch usages, and for most commands here referring to a branch is unecessary, but to use `push` it is required. 168 | 169 | > *NOTE:* Only changes that have been committed will be pushed. If you push changes to GitHub and you don't see them reflected in your remote project, check that you actually commited them. 170 | 171 | ## Working With Remote Repositories 172 | 173 | Working with only a local repository is fine for some purposes, but you'll quickly find it better to connect your local repository to a remote repository. Using a remote repository allows you to: 174 | - easily back up your project 175 | - collaborate with other programmers 176 | - work on the same project on different computers 177 | - make your code accessible to others (to show to a potential employer, for instance) 178 | 179 | At LaunchCode we'll always use [GitHub](https://github.com/) to store our remote repositories, but there are other applications for hosting remote repositories, including [GitLab](https://about.gitlab.com/) and [Bitbucket](https://bitbucket.org/). 180 | 181 | ### Creating a Remote Repo at GitHub 182 | 183 | When signed in, you can create a new remote repository by clicking on the plus icon near your profile, at the top right. 184 | 185 | New Repository 186 | 187 | Fill out the resulting form and submit to create a new repository. You now need to connect your local repository to your remote. First, copy the remote repository URL from the the screen you're on: 188 | 189 | Copy URL from new repository 190 | 191 | If you chose to initialize your repository with a `README` or `.gitignore` file, your screen will look slightly different. Copy the project URL using the **Clone or download** button on your project's page (see screenshot and note above). 192 | 193 | Then, from the terminal, in your project directory: 194 | ```nohighlight 195 | $ git remote add origin PROJECT_URL 196 | ``` 197 | 198 | This command can be verbalized as, "Hey, git, add a new remote repository connection named 'origin', which lives on the web at PROJECT_URL". The first portion of this command -- `git remote add` -- must always be the same. The `origin` piece is a name that we've chosen to refer to our remote repository. If you have multiple remotes, or want to choose a different name, you may do so. However, you must use this name when pushing/pulling code to/from the remote repository. `origin` is a widely-used default name when you only have one remote (as will almost always be the case in LaunchCode classes). 199 | 200 | ### Forking a Repository at GitHub 201 | 202 | A scenario that will occur from time-to-time in LaunchCode courses, and which occurs quite a lot for developers in general, is that of wanting to copy another developer's project and modify it. This process is known as "forking a repository" since if you view a project's history as a timeline, copying it effectively creates a "fork" in that history. 203 | 204 | To fork another developer's repository, visit the project at GitHub and hit the Fork button: 205 | 206 | Fork button 207 | 208 | This will create a *copy* of the remote repository under your own GitHub profile. You will have a snapshot of the other developer's repository, taken at the moment you hit the Fork button. 209 | 210 | From your own profile page, you will see the forked repository listed alongside your other repositories. To work on the code, clone the repository to your computer using the method at the top of this cheatsheet. 211 | 212 | Forked repositories can easily be identified by the reference to the original project under the project name on your profile. 213 | 214 | Forked repository 215 | 216 | ## Helpful Git Resources 217 | 218 | [Pro Git Book](https://git-scm.com/book/en/v2) - A reference book covering Git in depth. 219 | 220 | [Flight Rules for Git](https://github.com/k88hudson/git-flight-rules) - A "How to" guide for git 221 | 222 | [Interactive GitHub Sandbox](https://try.github.io) - A place to practice git without fear of messing anything up. 223 | 224 | [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) 225 | 226 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------