GitHub guide

Forking Arcticons

I'd recommend using GitHub Desktop to make Git less difficult.

  • Download & Install GitHub Desktop, and login with your credentials

  • Click on Add > Clone repository and select your Arcticons repo. This will create a folder with the Arcticons project.

Now you have your local Arcticons project. This means you can add icons and edit the appfilter.

Adding your icons

After having your icons created, you can export them as SVG files to the /newicons directory.

In this folder, you'll also see a file named appfilter.xml To tie the icon to the app, you will need to add some lines of code to this file. These lines of code can be gathered with Icon Request.

  1. Download Icon Request on your phone

  2. In the app, tap update existing.

  3. Select Arcticons when asked to choose an icon pack.

  4. Select the apps that you want to add.

  5. Tap the share icon in the top-right corner and send it to yourself.

Now you can add these lines to the appfilter. You don't have to worry about putting everything in alphabetical order, just paste it somewhere. It gets sorted automatically with every release.

Uploading to GitHub

Now, when you open your GitHub Desktop window, you'll see a summary of the changes that you've made.

  1. Give your commit a small summary.

  2. Press the Current branch button, then create a new branch. Give it a name and press Create.

  3. Publish your branch and commit the changes.

  4. Now you can create a pull request by pressing the button. This will open the GitHub site again.

  5. Create your pull request and you're done!

There you go, now all you have to do is wait for it to be merged into the app.


Alternatively, you can also do it all in your browser:

Uploading in Browser

  • Go to the GitHub page https://github.com/Arcticons-Team/Arcticons/ in a browser.

  • In the top-right corner, click the Fork button. You'll get your very own clone of Arcticons! (You need a GitHub account for this).

  • Once in your fork, click "newicons" directory.

  • Click "Add file" > Upload files > choose your files.

  • Select your masterpiece(s) and commit changes (you can add a commit message if you want).

  • There will be a dialog "… is 1 commit ahead of Arcticons-Team/Arcticons:main".

  • Click "Contribute" > "Open pull request".

  • Type the pull-request message (e.g., name of the icons).

  • Click "create pull request".

There you go! Just wait for your changes to be merged into the app, and be happy, you are a contributor!

Last updated

Logo

Arcticons