This repository contains posters that will be printed and used to redecorate the wall in the FsInf rooms (@TUWien).
The structure in the projects is as followed:
.
├── poster1/
│ ├── README.md
│ ├── poster.pdf
│ ├── poster.kra
│ └── something.ink
├── poster2/
│ ├── README.md
│ ├── poster.pdf
│ └── poster.ink
├── how_to_be_a_cat/
│ ├── README.md
│ ├── poster.pdf
│ ├── main_cat.gimp
│ └── cat.png
└── ...
The top level folder e.g. how_to_be_a_cat should be the name of the poster.
This folder must contain the following required files:
- README.md
- poster.pdf
The README.md should explain what program needs to be used to open the poster raw files. An image of the finished poster. Additional info that could be helpful would also be highly appreciated. The README can also contain information about the author and when it was created, but this is optional.
The poster.pdf should be in A2 format with the color space CMYK (needed by the print shop). If possible, the PDF standard should be PDF/X-3:2002. Make sure the resolution is high enough, but no so high that it takes 2 hours to open the image. If for some reason PDF-export is not an option, then TIF (poster.tif) or JPG (poster.jpg) can also be used (both in CMYK).
All other files in this folder should be the raw files that are needed to edit or reexport the poster.
For examples, you may look at existing folders.
Some no-goes for posters:
- Keep it SFW (safe for work)
- No-discrimination
If you are unsure if your poster idea breaks the rules, you can ask someone at mattermost poster-creation-channel. (You can only post there if you are a student at TUWien)
The main communication channel besides GitHub is on Mattermost in the poster-creation-channel (You can only post there if you are a student at TUWien)
In this channel one can ask questions on how poster are created, discuss questions or share knowledge.
If you want to contribute, then you can do so in the following ways:
If you want to submit a new poster idea, you can do so by creating a new issue for this repository. The issue should have a short and informative name that makes it clear what the poster is about. Each issue should also contain a description with more details that can be used by others to design the poster. For examples, look below or at the already existing issues. The issue should also have the label poster idea.
Title: How to use git
Description:
This poster should contain the most used git command and what they do:
* git add
* git commit
* git push
* git pull
* git clone
If there is still some space left it could contain examples or reasons why git should be used.
If you want to create a new poster, you can do so by first forking the repository to your own account. Make sure that an issue exists for the poster idea, if not, just create one (see above). After that, create the poster and commit it to your forked repository. If you are finished, make sure that all the required files exist, and then you can create a pull request on the fsinf repository to get your changes back into the main repository. The pull request should mention the poster issue for which the poster was created. It would also be nice to attach some images of the created poster inside the pull request.
Here is an example pull request:
If you don't know how to fork a repository and create a pull request, you can watch this video: GitHub Pull Request in 100 Seconds
This section is for all those who have never used it and have no idea on how any of this works. If you think git is overly complicated, and you don't need to use it the first, consider the following:
- You will need to use it in multiple project at the university.
- If you learn it, knowing it will make the subject where you need to use it somewhat easier.
- It prevents you from losing code due to overwriting it.
- You can always go back to a previous version.
- It makes collaborating easier.
- Almost all open source projects use it.
There are two main ways to use git. You can either use it via the CLI or via a GUI application. The GUI application has an easier onboarding process, and most of the time you can start using git right away. The CLI version is a bit harder to learn but gives you more fine-grained control over what happens. Another point to consider is that it is more likely to have the git CLI version on the system than a specific GUI application.
Git CLI Tutorials
Git GUIs
- GitButler (Linux & Mac)
- Git in VsCode (Linux & Mac & Windows)
- GitHub Desktop (Linux & Mac & Windows)