Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
franciscoamado committed Sep 24, 2018
1 parent abda3c5 commit 69b0a55
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
Binary file added .github/AppIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/sortify.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Sortify
#### Xcode Source Editor Extension for Sorting Lines

<div align="center">
<img src=".github/AppIcon.png">
</div>

This was built as a prototype to test Xcode Extensions.

## Installation

### Build

Using `Xcode 9+`
1. Download the source code.
2. Open the Sortify.xcodeproj and run the _SortifyExtension_ target, choosing Xcode as the host application.

This is a **temporary installation** as it will only work when running the project.

### Zip

1. Download the [latest release](https://github.com/FranciscoAmado/Sortify/releases) `Sortify.zip`
2. Open the `Sortify.app`, which will add the Extension to Xcode.
3. (Optional) Move the `Sortify.app` to the `Applications` folder.

You can validate if the Extension is enabled in `System Preferences >> Extensions`

## Usage

1. Select the lines that will be sorted in the open file
2. Xcode >> Editor >> Sortify >> **Sort Selected Lines**

![Sortify in Xcode](./.github/sortify.gif)

## Known issues

* Simple text sorting
* Text needs to be aligned to work properly

## TODO

- [ ] Maybe add `import` sorting

## Acknowledgments

App Icon Arrow made by <a href="https://www.flaticon.com/authors/dave-gandy" title="Dave Gandy">Dave Gandy</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a>

All the rest is free.

## Contributing

Open an [issue](https://github.com/FranciscoAmado/Sortify/issues/new) or a [Pull Request](https://github.com/FranciscoAmado/Sortify/compare). All help is appreciated.

0 comments on commit 69b0a55

Please sign in to comment.