|
1 |
| -<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord-xcode/develop/assets/nord-xcode-banner.svg"/></p> |
| 1 | +<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> |
2 | 2 |
|
3 |
| -<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> |
| 3 | +<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> |
4 | 4 |
|
5 |
| -<p align="center">An arctic, north-bluish clean and elegant <a href="https://developer.apple.com/xcode">Xcode</a> color theme.</p> |
| 5 | +<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> |
6 | 6 |
|
7 |
| -<p align="center">Designed for a fluent and clear workflow.<br> |
8 |
| -Based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color palette.</p> |
| 7 | +<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> |
9 | 8 |
|
10 |
| ---- |
| 9 | +<p align="center">An arctic, north-bluish clean and elegant <a href="https://developer.apple.com/xcode" target="_blank">Xcode</a> theme.</p> |
11 | 10 |
|
12 |
| -<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> |
| 11 | +<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> |
13 | 12 |
|
14 |
| - - [Getting started](#getting-started) |
15 |
| - - [Installation](#installation) |
16 |
| - - [Manual](#manual) |
17 |
| - - [Install Script](#install-script) |
18 |
| - - [Activation](#activation) |
19 |
| - - [Asset Catalog](#asset-catalog) |
20 |
| - - [Color Set](#color-set) |
21 |
| - - [Development](#development) |
22 |
| - - [Contribution](#contribution) |
| 13 | +<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> |
23 | 14 |
|
24 | 15 | ## Getting started
|
25 |
| -### Installation |
26 |
| -#### Manual |
27 |
| -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`. |
28 | 16 |
|
29 |
| -#### Install Script |
30 |
| -The included `install.sh` shell script can be used for an automated installation. |
| 17 | +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]. |
| 18 | + |
| 19 | +### Quick Start |
| 20 | + |
| 21 | +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. |
31 | 22 |
|
32 |
| -A list of available options can be shown with the `--help` option. |
33 | 23 | ```sh
|
34 |
| -./install.sh --help |
| 24 | +mkdir -p ~/Library/Developer/Xcode/UserData/FontAndColorThemes |
| 25 | +curl https://raw.githubusercontent.com/arcticicestudio/nord-xcode/develop/src/Nord.xccolortheme -o ~/Library/Developer/Xcode/UserData/FontAndColorThemes/Nord.xccolortheme |
35 | 26 | ```
|
36 |
| -Syntax: `install.sh [OPTIONS]` |
37 | 27 |
|
38 |
| -| Option | Description | |
39 |
| -| --- | --- | |
40 |
| -| `-h`, `--help` | Shows the help | |
41 |
| -| `-v`, `--verbose` | Verbose output | |
42 |
| -| `-c <COLOR_THEME_FILE>`, `--colortheme <COLOR_THEME_FILE>` | Use the specified color theme file | |
| 28 | +For more details see the [official installation & activation guide][nord-docs-home-install]. |
| 29 | + |
| 30 | +#### Latest Development State |
| 31 | + |
| 32 | +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: |
| 33 | + |
| 34 | +```sh |
| 35 | +git clone https://github.com/arcticicestudio/nord-xcode |
| 36 | +ln -sr "$PWD/src/Nord.xccolortheme" "$HOME/Library/Developer/Xcode/UserData/FontAndColorThemes/Nord.xccolortheme" |
| 37 | +``` |
| 38 | + |
| 39 | +#### Activation |
| 40 | + |
| 41 | +To activate and use Nord Xcode as your default color theme… |
43 | 42 |
|
44 |
| -### Activation |
45 |
| - 1. Open *File* > *Preferences* |
46 |
| - 2. Switch to the *Fonts & Colors* tab |
47 |
| - 3. Select `Nord` from the list |
| 43 | +1. …open _File_ > _Preferences_ |
| 44 | +2. …switch to the _Fonts & Colors_ tab |
| 45 | +3. …select _Nord_ from the list |
48 | 46 |
|
49 |
| -<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> |
| 47 | +<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-activation.png"/></p> |
50 | 48 |
|
51 |
| -## Asset Catalog |
| 49 | +## Features |
52 | 50 |
|
53 |
| -### Color Set |
| 51 | +<p align="center"><strong>Beautiful code to keep focused.</strong></p> |
| 52 | +<p align="center">The color scheme supports all syntax types available in Xcode.</p> |
| 53 | +<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/editor-syntax_types.png"/></p> |
54 | 54 |
|
55 |
| -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:)`. |
| 55 | +<p align="center"><strong>Nord as color set.</strong></p> |
| 56 | +<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> |
| 57 | +<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-asset_catalog.png"/></p> |
56 | 58 |
|
57 |
| -Install it by [adding the][add-folder-to-project] [nord.xcassets][nord-xcassets] [folder to the project][add-folder-to-project]. |
| 59 | +<p align="center"><strong>Build beautiful UI elements with Nord.</strong></p> |
| 60 | +<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> |
| 61 | +<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/ports/xcode/ui-interface_builder.png"/></p> |
58 | 62 |
|
59 |
| -<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> |
| 63 | +## Contributing |
60 | 64 |
|
61 |
| -For more information please read the official documentation section on how to [create a color set to use in Interface Builder][asset-catalog-creation]. |
| 65 | +Nord is an open source project and we love to receive contributions from the [community][nord-comm]! |
62 | 66 |
|
63 |
| -<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> |
| 67 | +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]. |
64 | 68 |
|
65 |
| -## Development |
66 |
| -[](https://github.com/arcticicestudio/nord-xcode/blob/v0.1.0/CHANGELOG.md) [](http://nvie.com/posts/a-successful-git-branching-model) [](https://github.com/arcticicestudio/arcver) |
| 69 | +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. |
67 | 70 |
|
68 |
| -### Contribution |
69 |
| -Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-xcode/issues). |
| 71 | +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]. |
70 | 72 |
|
71 |
| -<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg" /></p> |
| 73 | +<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p> |
72 | 74 |
|
73 |
| -<p align="center">Copyright © 2017-present Arctic Ice Studio</p> |
| 75 | +<p align="center">Copyright © 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> |
74 | 76 |
|
75 |
| -<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> |
| 77 | +<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> |
76 | 78 |
|
77 |
| -[asset-catalog]: https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_ref-Asset_Catalog_Format |
78 |
| -[asset-catalog-creation]: http://help.apple.com/xcode/mac/current/#/dev10510b1f7 |
79 |
| -[interface-builder]: https://developer.apple.com/xcode/interface-builder |
80 |
| -[add-folder-to-project]: http://help.apple.com/xcode/mac/current/#/dev81ce1d383 |
81 |
| -[nord-xcassets]: https://github.com/arcticicestudio/nord-xcode/tree/develop/src/nord.xcassets |
| 79 | +[gh-repo]: https://github.com/arcticicestudio/nord-xcode |
| 80 | +[gh-tree-xccolortheme]: https://github.com/arcticicestudio/nord-xcode/blob/develop/src/Nord.xccolortheme |
| 81 | +[nord-comm]: https://www.nordtheme.com/community |
| 82 | +[nord-contrib-guide-branching]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#branch-organization |
| 83 | +[nord-contrib-guide-bugs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#bug-reports |
| 84 | +[nord-contrib-guide-docs]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#documentations |
| 85 | +[nord-contrib-guide-enhance]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#enhancement-suggestions |
| 86 | +[nord-contrib-guide-feedback]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#give-feedback-on-issues-and-pull-requests |
| 87 | +[nord-contrib-guide-impr-issues]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#improve-issues |
| 88 | +[nord-contrib-guide-mcve]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#mcve |
| 89 | +[nord-contrib-guide-pr]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#pull-requests |
| 90 | +[nord-contrib-guide-styles]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#styleguides |
| 91 | +[nord-contrib-guide-versioning]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md#versioning |
| 92 | +[nord-contrib-guide]: https://github.com/arcticicestudio/nord/blob/develop/CONTRIBUTING.md |
| 93 | +[nord-docs-home-install]: https://www.nordtheme.com/docs/ports/xcode/installation |
| 94 | +[nord-docs-home]: https://www.nordtheme.com/docs/ports/xcode |
| 95 | +[nord-home]: https://www.nordtheme.com/ports/xcode |
| 96 | +[nord-home#intro]: https://www.nordtheme.com/ports/xcode#introduction |
| 97 | +[nord-home#ui-elements]: https://www.nordtheme.com/ports/xcode#ui-elements |
| 98 | +[wiki-symlink]: https://en.wikipedia.org/wiki/Symbolic_link |
0 commit comments