Getting Started

Hey! Welcome to Asylum! Want to work on a project but have no clue how to start? You are in the right place!

Getting Started With Git

Asylum is hosted on GitHub so it will be very helpful to know how git works. Let's start with the basics. Git is a version control system that allows you to keep track of changes in your code. It is very helpful when working with other people on a project because each person can work on their own part and then merge their changes later. If you are new to git, I would recommend watching this video series to learn the basics.

You don't need to understand git to participate, but knowing how to use it through a terminal will be helpful, although not necessary. You can use the GitHub website to do most things that you would do through the terminal.

GitHub

GitHub is a website that hosts git repositories. It is where the Asylum repository is located and where you will submit your projects. If you don't have a GitHub account, you will need to create one in order to submit your project.

Once you have your account, you will need to fork the Asylum repository. Click the 'Fork' button at the top of the page and then 'Create Fork' to confirm. This fork is where you will make your modifications and upload your files.

Projects

When a new project is released, a new folder will be added to the designs folder in the Asylum repository. A bar that says you are behind the main repository will be shown in your fork with two buttons. Click the on one the right that says 'Sync fork' and click 'Update Branch'. This will update your fork with the new project folder and any other changes that have been made to the main repository.

You can now work on the project. There will be some instructions in the folder for that project but I will also try to get a short page for each project up on this website in the archive section as soon as I can. There will also be guides for each project to help you get started but it will probably take at least a few days after the project is released before it is ready.