Welcome to this tutorial repository! (I really need a different name for this thing.) This README should give you everything you need to setup your own repository on GitHub or any other web-hoster you hold! For the sake of time and money, I'll be using GitHub for this tutorial, because you know, well, it's free.
- Linux. Sorry boys, but Cydia runs off of Debian packages (.deb) and the quickest and most efficient way to make these is with a Debian-based Linux installation, such as Ubuntu or Debian itself. But, don't worry, Linux is free! #linuxmasterrace
- Git version 1.7 or higher. (This is only required if you are pushing your repository to a git-based system, such as GitHub, which will be used in this tutorial.) To install this with your average Debian-based Linux distribution, type the command
sudo apt-get install gitin a terminal window.
- Download the zip file here and extract it to the location of your choice or open up your favourite terminal with Git installed and type in the command
git clone https://github.com/WinneonSword/tutorial-repository.git repo! This will create the the folder at the location you specified in your terminal with all of this repository's contents inside.
- Hold on, no profit for you yet.
How It Works
Okay, so now you've downloaded the thing and it's a folder with a bunch of random files in it that make absolutely no sense whatsoever. Now what?! Here's what. You see you unroll it, then you stick it i— whoops.
Never mind that, the first thing you need to understand is how these debian things work. To start, Cydia, as you probably already know now, is the main program created by /u/saurik for jailbroken iOS devices for easy and quick access to the tweaks and themes that you want. You probably have never thought of how Cydia does this, unless you're into that sort of stuff. Cydia basically to put it into laymon terms, uses Debian packages to download and install these tweaks. Debian packages, more commonly known as the .deb files that Debian uses, are basically advanced .zip files, like Java JARs, also known as .jar files. Debian reads these special .zip files and installs them accordingly with information found in the package's control file. This control file is put into a special location inside the .deb file.
As an example, I have one .deb file in this repository that is already fully packaged and ready to be downloaded in Cydia. If you crack this .deb file with your favourite uncompresser (7-Zip for the win), you will see two folders. A folder marked
DEBIAN, and a folder marked
The folder marked
DEBIAN is the folder that contains the control file, which is called
control. Bet you didn't see that coming. (I'm so good at jokes! Hehehe... heh....) The control file contains many fields that have specific information that Debian reads when installing the package. We'll get into that in a bit.
The folder marked
var is where you want your files for your tweak or theme to go. I have no prior experience for tweaking, seeing as I don't own a Mac, but for themers such as myself, the place to put your average theme would be at
/Library/Themes/. This would mean to make a folder called
Library, and then a folder called
Themes inside of that, in your package folder. The reason why the folder in this case is called
var, is because I'm installing a test file to
/var/mobile/Documents/. But I'm pretty sure you get the idea.
The control file
The control file is made up of several fields. I'm going to cover the main ones you will be using. Inside the package folder, which in this case, is called
Package (I'm no longer inside the example .deb file anymore if you didn't know.), is a
DEBIAN folder, and inside that is the control file. Crack this puppy open, and you will see several fields. The fields you see should look similar to the ones below.
Package: net.winneonsword.package Name: Test Package Version: 1.0 Architecture: iphoneos-arm Description: This is a test package from /u/WinneonSword's tutorial repository! Depiction: http://repo.winneonsword.net/packages/package.html Homepage: http://repo.winneonsword.net Maintainer: Jesse Bryan <email@example.com> Author: Jesse Bryan <firstname.lastname@example.org> Section: Themes
Let's go down the line and explain what each one means.
- Package: This is the name of your package. If you're not familiar with programming, the package name is usually where most of the files the program code relates to goes. The way to name this is like so:
[prefix of your website].[name of your website].[name of package]. For example, mine says
netis the prefix of my website, the
winneonswordis the name of my website, which both together puts winneonsword.net, which is my website, and the last part, the
packageis the name of the package. For example's sake, it's just called package in this tutorial.
- Name: This is what will show as the name when you are looking at your package in Cydia. You know, the big bold text that is the main attraction.
- Version: This is the version of your package. Versioning is something to get into the habit of. The way I do it though, is if it is a initial release, then it obviously is version 1.0. If it is a minor change, then I add a number to the 3rd digit, which in this case would turn into 1.0.1. If it was a major change, then I would add a number to the 2rd digit and remove the 3rd, which would turn into 1.1. Get it?
- Architecture: This is the type of the package. Don't change this.
- Description: This is the description of your package. This text section will appear under entries in Cydia in a list view, or if there is no depiction for the file (below), when viewing the package itself in the dotted-line division area.
- Depiction: This is the webpage that pops up when viewing the package itself in Cydia. This part is optional, and should only be used if you know what you are doing around mobile web development. Keep in mind, that if you have a depication specified, the description of the package will not show up when viewing the package directly in Cydia.
- Homepage: This part is pretty obvious; it's the package's homepage, or mainly your website's homepage.
- Maintainer: This is the person who is currently maintaining the package you are making. To put the person's email, enclose it in tag symbols, like so:
<email@example.com>. This is shown in the above example.
- Author: This is the person who originally created the package you are maintaining. This often is the same as the Maintainer.
- Section: Last but not least, this is the Section that the package will go under when you view the section view in Cydia. Pretty straightforward, eh?
Making Your Packages and Sending Them Off
This is reaching the end of this tutorial, so now to conclude the repository making process. Below are step by step instructions on how to make your packages into .deb files, and then send it off to a Git based system, in this case, will be GitHub.
Update your packages.sh file. To do so, crack open the packages.sh file, and you should see
dpkg-deb -b Package. Repeat this pattern for every package that your have in your repository, so if you were to have 3 packages, the packages.sh file should look like so. Keep in mind that the name of the package is the same as the folder name in the repository.
dpkg-deb -b Package dpkg-deb -b Package2 dpkg-deb -b Package3
Run the update.sh file in your terminal by typing
./update.sh. If you get an error mid-way, run this command:
chmod +x packages.sh && chmod +x remove.sh && chmod +x update.sh. Then, run the file again.
Now that you have all of your .debs properly built, you need to send the files along with the Packages.bz2 to the Git repository of your choice. If you are not using GitHub, you are done with these steps. Otherwise, create a GitHub repository on the GitHub website with this name:
[your github username].github.com. Replace the [your github username] part with your actual GitHub username. This is very important.
Now, in your favourite terminal full of rainbows and sparkles and glitter and ponies and all that neat stuff, type the following set of commands in the repository directory:
git init git remote add origin https://github.com/[your github username]/[your github username].github.com.git git add --all git commit -m "[Put a creative name for this commit here.]" git push origin master
Congratulations! You may have your PROFIT you've been waiting for. Your repository should now be up and running at
http://[your github username].github.com/! Add that web address to your Cydia sources and behold your packages should appear!
Thank you for listening for my ongoing blabber about Debian and how things work. This method is how you would get an actual repository up and running without using myrepospace or any similar service. This method also allows full control over all of your packages to your hearts content, and it allows a neat and clean way to redirect the web address to your custom domain of your choice, using GitHub's CNAME system. (I will not be going into that in this tutorial. Sorry!) I hope you enjoyed this tutorial, and farewell!