Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nord Docs Transition #10

Merged
merged 1 commit into from
Dec 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Copyright (C) 2017-present Arctic Ice Studio <[email protected]>
# Copyright (C) 2017-present Sven Greb <[email protected]>
#
# Project: Nord Xcode
# Repository: https://github.com/arcticicestudio/nord-xcode
# License: MIT

# +--------------------+
# + Base Configuration +
# +--------------------+
Expand All @@ -7,12 +14,12 @@ end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
max_line_length = 160
max_line_length = 120
trim_trailing_whitespace = true

# +-----------+
# + Languages +
# +-----------+
# +--- Markdown ---+
[*.{md,gfm}]
[*.{md}]
trim_trailing_whitespace = false
13 changes: 13 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright (C) 2017-present Arctic Ice Studio <[email protected]>
# Copyright (C) 2017-present Sven Greb <[email protected]>
#
# Project: Nord Xcode
# Repository: https://github.com/arcticicestudio/nord-xcode
# License: MIT
# References:
# https://git-scm.com/docs/gitattributes
# https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Keyword-Expansion

# Automatically perform line feed (LF) normalization for files detected as text and leave all files detected as binary
# untouched.
* text=auto
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-xcode/develop/src/assets/nord-xcode-banner.svg"/></p>
<p align="center"><a href="https://www.nordtheme.com/ports/xcode" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/repository-hero.svg?sanitize=true"/></a></p>

<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-xcode/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-v0.2.0-88C0D0.svg?style=flat-square"/></a> <a href="https://developer.apple.com/xcode"><img src="https://img.shields.io/badge/Xcode-v8+-1C91FE.svg?style=flat-square"/></a></p>
<p align="center"><a href="https://github.com/arcticicestudio/nord-xcode/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a> <a href="https://www.nordtheme.com/docs/ports/xcode"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square&label=Docs&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiI%2BCiAgICA8cGF0aCBmaWxsPSIjZDhkZWU5IiBkPSJNMTMuNzQ2IDIuODEzYS42Ny42NyAwIDAgMC0uNTU5LS4xMzNMOCAzLjg0OGwtNS4xODgtMS4xOGEuNjY5LjY2OSAwIDAgMC0uNTcuMTMzLjY3Ny42NzcgMCAwIDAtLjI0Mi41MzF2OC4xMzNjLS4wMDguMzIuMjEuNTk4LjUyLjY2OGw1LjMzMiAxLjE5OWguMjk2bDUuMzMyLTEuMmEuNjY4LjY2OCAwIDAgMCAuNTItLjY2N1YzLjMzMmEuNjU5LjY1OSAwIDAgMC0uMjU0LS41MnpNMy4zMzIgNC4xNjhsNCAuODk4djYuNzY2bC00LS44OTh6bTkuMzM2IDYuNzY2bC00IC44OThWNS4wNjZsNC0uODk4em0wIDAiLz4KPC9zdmc%2BCg%3D%3D"/></a></p>

---
<p align="center">Changelog for <a href="https://www.nordtheme.com/ports/xcode" target="_blank">Nord Xcode</a> — An arctic, north-bluish clean and elegant <a href="https://developer.apple.com/xcode" target="_blank">Xcode</a> theme.</p>

<!--lint disable no-duplicate-headings-->

# 0.1.0
*2017-04-23*
Expand Down
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
MIT License (MIT)

Copyright (c) 2017-present Arctic Ice Studio <[email protected]> (http://arcticicestudio.com)
Copyright (c) 2017-present Sven Greb <code@svengreb.de> (http://svengreb.de)
Copyright (C) 2017-present Arctic Ice Studio <[email protected]> (https://www.arcticicestudio.com)
Copyright (C) 2017-present Sven Greb <development@svengreb.de> (https://www.svengreb.de)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
123 changes: 70 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,98 @@
<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-xcode/develop/assets/nord-xcode-banner.svg"/></p>
<p align="center"><a href="https://www.nordtheme.com/ports/xcode" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/repository-hero.svg?sanitize=true"/></a></p>

<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/nord-xcode/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/nord/releases/tag/v0.2.0"><img src="https://img.shields.io/badge/Nord-v0.2.0-88C0D0.svg?style=flat-square"/></a> <a href="https://developer.apple.com/xcode"><img src="https://img.shields.io/badge/Xcode-v8+-1C91FE.svg?style=flat-square"/></a></p>
<p align="center"><a href="https://github.com/arcticicestudio/nord-xcode/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a> <a href="https://www.nordtheme.com/docs/ports/xcode"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square&label=Docs&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiI%2BCiAgICA8cGF0aCBmaWxsPSIjZDhkZWU5IiBkPSJNMTMuNzQ2IDIuODEzYS42Ny42NyAwIDAgMC0uNTU5LS4xMzNMOCAzLjg0OGwtNS4xODgtMS4xOGEuNjY5LjY2OSAwIDAgMC0uNTcuMTMzLjY3Ny42NzcgMCAwIDAtLjI0Mi41MzF2OC4xMzNjLS4wMDguMzIuMjEuNTk4LjUyLjY2OGw1LjMzMiAxLjE5OWguMjk2bDUuMzMyLTEuMmEuNjY4LjY2OCAwIDAgMCAuNTItLjY2N1YzLjMzMmEuNjU5LjY1OSAwIDAgMC0uMjU0LS41MnpNMy4zMzIgNC4xNjhsNCAuODk4djYuNzY2bC00LS44OTh6bTkuMzM2IDYuNzY2bC00IC44OThWNS4wNjZsNC0uODk4em0wIDAiLz4KPC9zdmc%2BCg%3D%3D"/></a> <a href="https://github.com/arcticicestudio/nord-xcode/blob/develop/CHANGELOG.md#050"><img src="https://img.shields.io/github/release/arcticicestudio/nord-xcode.svg?style=flat-square&label=Changelog&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>

<p align="center">An arctic, north-bluish clean and elegant <a href="https://developer.apple.com/xcode">Xcode</a> color theme.</p>
<p align="center"><a href="https://github.com/arcticicestudio/styleguide-markdown/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-markdown.svg?style=flat-square&label=Markdown%20Style%20Guide&colorA=4c566a&colorB=88c0d0&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzOSIgaGVpZ2h0PSIzOSIgdmlld0JveD0iMCAwIDM5IDM5Ij48cGF0aCBmaWxsPSJub25lIiBzdHJva2U9IiNEOERFRTkiIHN0cm9rZS13aWR0aD0iMyIgc3Ryb2tlLW1pdGVybGltaXQ9IjEwIiBkPSJNMS41IDEuNWgzNnYzNmgtMzZ6Ii8%2BPHBhdGggZmlsbD0iI0Q4REVFOSIgZD0iTTIwLjY4MyAyNS42NTVsNS44NzItMTMuNDhoLjU2Nmw1Ljg3MyAxMy40OGgtMS45OTZsLTQuMTU5LTEwLjA1Ni00LjE2MSAxMC4wNTZoLTEuOTk1em0tMi42OTYgMGwtMTMuNDgtNS44NzJ2LS41NjZsMTMuNDgtNS44NzJ2MS45OTVMNy45MzEgMTkuNWwxMC4wNTYgNC4xNnoiLz48L3N2Zz4%3D"/></a> <a href="https://github.com/arcticicestudio/styleguide-git/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-git.svg?style=flat-square&label=Git%20Style%20Guide&logoColor=eceff4&colorA=4c566a&colorB=88c0d0&logo=git"/></a></p>

<p align="center">Designed for a fluent and clear workflow.<br>
Based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.</p>
<p align="center"><a href="https://developer.apple.com/xcode" target="_blank"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=Compatibility&message=8%2B&logo=xcode&logoColor=eceff4&colorA=4c566a&colorB=1c91fe"/></a></p>

---
<p align="center">An arctic, north-bluish clean and elegant <a href="https://developer.apple.com/xcode" target="_blank">Xcode</a> theme.</p>

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-preview.png"/><blockquote>Font: <a href="https://developer.apple.com/fonts">SF Mono</a> 12px.</blockquote></p>
<p align="center">Designed for a fluent and clear workflow based on the <a href="https://www.nordtheme.com" target="_blank">Nord</a> color palette.</p>

- [Getting started](#getting-started)
- [Installation](#installation)
- [Manual](#manual)
- [Install Script](#install-script)
- [Activation](#activation)
- [Asset Catalog](#asset-catalog)
- [Color Set](#color-set)
- [Development](#development)
- [Contribution](#contribution)
<p align="center"><a href="https://www.nordtheme.com/ports/xcode" target="_blank"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/overview.png"/></a></p>

## Getting started
### Installation
#### Manual
Copy the [`Nord.xccolortheme`](https://github.com/arcticicestudio/nord-xcode/blob/develop/src/Nord.xccolortheme) file to the color theme directory `~/Library/Developer/Xcode/UserData/FontAndColorThemes`.

#### Install Script
The included `install.sh` shell script can be used for an automated installation.
Visit the [official website][nord-home] to learn all about the [features][nord-home#intro], how to [install and activate][nord-docs-home-install] the theme, the [color set for the asset catalog][nord-home#ui-elements] and more from the [official documentations][nord-docs-home].

### Quick Start

Nord Xcode can be installed by downloading the latest [`Nord.xccolortheme`][gh-tree-xccolortheme] file from the [GitHub repository][gh-repo] and place it into the `~/Library/Developer/Xcode/UserData/FontAndColorThemes` directory.

A list of available options can be shown with the `--help` option.
```sh
./install.sh --help
mkdir -p ~/Library/Developer/Xcode/UserData/FontAndColorThemes
curl https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/src/Nord.xccolortheme -o ~/Library/Developer/Xcode/UserData/FontAndColorThemes/Nord.xccolortheme
```
Syntax: `install.sh [OPTIONS]`

| Option | Description |
| --- | --- |
| `-h`, `--help` | Shows the help |
| `-v`, `--verbose` | Verbose output |
| `-c <COLOR_THEME_FILE>`, `--colortheme <COLOR_THEME_FILE>` | Use the specified color theme file |
For more details see the [official installation & activation guide][nord-docs-home-install].

#### Latest Development State

To always use the latest development state of Nord Xcode, [clone the repository][gh-repo] and create a [symbolic link][wiki-symlink] of the [`Nord.xccolortheme`][gh-tree-xccolortheme] file to `~/Library/Developer/Xcode/UserData/FontAndColorThemes/Nord.xccolortheme` afterwards:

```sh
git clone https://github.com/arcticicestudio/nord-xcode
ln -sr "$PWD/src/Nord.xccolortheme" "$HOME/Library/Developer/Xcode/UserData/FontAndColorThemes/Nord.xccolortheme"
```

#### Activation

To activate and use Nord Xcode as your default color theme…

### Activation
1. Open *File* > *Preferences*
2. Switch to the *Fonts & Colors* tab
3. Select `Nord` from the list
1. …open _File_ > _Preferences_
2. …switch to the _Fonts & Colors_ tab
3. …select _Nord_ from the list

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-docs-preferences-editor.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-docs-preferences-console.png"/></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-activation.png"/></p>

## Asset Catalog
## Features

### Color Set
<p align="center"><strong>Beautiful code to keep focused.</strong></p>
<p align="center">The color scheme supports all syntax types available in Xcode.</p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/editor-syntax_types.png"/></p>

Nord XCode provides a [asset catalog][asset-catalog] color set which can be used as named colors in the [Interface Builder][interface-builder] and programmatically via `UIColor(named:)`.
<p align="center"><strong>Nord as color set.</strong></p>
<p align="center">All Nord colors right at your hand — Use the <a href="https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format" target="_blank">asset catalog</a> color set in the <a href="https://developer.apple.com/xcode/interface-builder" target="_blank">Interface Builder</a> and programmatically.</p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-asset_catalog.png"/></p>

Install it by [adding the][add-folder-to-project] [nord.xcassets][nord-xcassets] [folder to the project][add-folder-to-project].
<p align="center"><strong>Build beautiful UI elements with Nord.</strong></p>
<p align="center">Create UI elements in the Xcode <a href="https://developer.apple.com/xcode/interface-builder" target="_blank">Interface Builder</a> using Nord colors.</p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-interface_builder.png"/></p>

<p align="center"><strong>Usage with the Interface Builder</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-asset-catalog-color-set-interface-builder.png"/></p>
## Contributing

For more information please read the official documentation section on how to [create a color set to use in Interface Builder][asset-catalog-creation].
Nord is an open source project and we love to receive contributions from the [community][nord-comm]!

<p align="center"><strong>Asset Catalog - Color Set</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-asset-catalog-color-set.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrot-asset-catalog-color-set-selected.png"/><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/assets/scrcast-assets-catalog-color-set.gif"/></p>
There are many ways to contribute, from [writing- and improving documentation and tutorials][nord-contrib-guide-docs], [reporting bugs][nord-contrib-guide-bugs], [submitting enhancement suggestions][nord-contrib-guide-enhance] that can be added to Nord by [submitting pull requests][nord-contrib-guide-pr].

## Development
[![](https://img.shields.io/badge/Changelog-0.1.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/nord-xcode/blob/v0.1.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow--branching--model-81A1C1.svg?style=flat-square)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/arcver)
Please take a moment to read Nord's full [contributing guide][nord-contrib-guide] to learn about the development process, the project's used [styleguides][nord-contrib-guide-styles], [branch organization][nord-contrib-guide-branching] and [versioning][nord-contrib-guide-versioning] model.

### Contribution
Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-xcode/issues).
The guide also includes information about [minimal, complete, and verifiable examples][nord-contrib-guide-mcve] and other ways to contribute to the project like [improving existing issues][nord-contrib-guide-impr-issues] and [giving feedback on issues and pull requests][nord-contrib-guide-feedback].

<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg" /></p>
<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>

<p align="center">Copyright &copy; 2017-present Arctic Ice Studio</p>
<p align="center">Copyright &copy; 2017-present <a href="https://www.arcticicestudio.com" target="_blank">Arctic Ice Studio</a> and <a href="https://www.svengreb.de" target="_blank">Sven Greb</a></p>

<p align="center"><a href="https://github.com/arcticicestudio/nord-xcode/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p>
<p align="center"><a href="https://github.com/arcticicestudio/nord-xcode/blob/develop/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>

[asset-catalog]: https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format
[asset-catalog-creation]: http://help.apple.com/xcode/mac/current/#/dev10510b1f7
[interface-builder]: https://developer.apple.com/xcode/interface-builder
[add-folder-to-project]: http://help.apple.com/xcode/mac/current/#/dev81ce1d383
[nord-xcassets]: https://github.com/arcticicestudio/nord-xcode/tree/develop/src/nord.xcassets
[gh-repo]: https://github.com/arcticicestudio/nord-xcode
[gh-tree-xccolortheme]: https://github.com/arcticicestudio/nord-xcode/blob/develop/src/Nord.xccolortheme
[nord-comm]: https://www.nordtheme.com/community
[nord-contrib-guide-branching]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#branch-organization
[nord-contrib-guide-bugs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#bug-reports
[nord-contrib-guide-docs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#documentations
[nord-contrib-guide-enhance]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#enhancement-suggestions
[nord-contrib-guide-feedback]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests
[nord-contrib-guide-impr-issues]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#improve-issues
[nord-contrib-guide-mcve]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#mcve
[nord-contrib-guide-pr]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#pull-requests
[nord-contrib-guide-styles]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#styleguides
[nord-contrib-guide-versioning]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#versioning
[nord-contrib-guide]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md
[nord-docs-home-install]: https://www.nordtheme.com/docs/ports/xcode/installation
[nord-docs-home]: https://www.nordtheme.com/docs/ports/xcode
[nord-home]: https://www.nordtheme.com/ports/xcode
[nord-home#intro]: https://www.nordtheme.com/ports/xcode#introduction
[nord-home#ui-elements]: https://www.nordtheme.com/ports/xcode#ui-elements
[wiki-symlink]: https://en.wikipedia.org/wiki/Symbolic_link
Loading