<commit_before>XAlign
======

a useful Xcode plugin to align regular code. it can align xnything with any format as u want.

## What's XAlign

there are some example format patterns below, of course, you can make your own. the example pattern file is under the `main` dir. Just try it yourself.

### 1. Align By Fisrt =
![Equal](http://github.so/XAlign/images/equal.gif)

### 2. Align By Define Group
![Equal](http://github.so/XAlign/images/define.gif)

### 3. Align By Property Group
![Equal](http://github.so/XAlign/images/property.gif)

## Install & Update

1. Terminally

   ```sh
    # install
    $ curl github.so/XAlign/build/install.sh | sh

    or

    # update
    $ curl github.so/XAlign/build/update.sh | sh
   ```

2. Manually

  1. Download this package [XAlign.tar.gz](http://github.so/XAlign/build/XAlign.tar.gz)
  2. then unpackage it, copy or move the `XAlign.xcplugin` to follow path:
    ```sh
    ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/
    ```
    tips: Quick go in finder `cmd+shift+g`; if there's no dir `Plug-ins`, you should make one.

  3. then restart your Xcode.

## Uninstall
```sh
$ curl github.so/XAlign/build/uninstall.sh | sh
```

## Usage
### Where in ur Xcode
```sh
Xcode -> Edit -> XAlign 
```

### Auto Align Shortcut (default)
```sh
shfit + cmd + x
```
You can setting in the setting panel, `Xcode -> Edit -> XAlign -> Setting`.


### Trouble-Shooting
  
  * [快捷键修改](https://github.com/qfish/XAlign/wiki/Trouble-Shooting#shortcut-conflicts)
   
  
## Not the end

~~I want to write more, but i am sleepy zzzzz. :)~~

TODO:

- [x] how to customize ur align pattern
- [x] my xcode plugin template
- [x] etc.
<commit_msg>Fix README spelling and formatting<commit_after>XAlign
======

A useful Xcode plugin to align regular code. It can align anything by using custom alignment patterns.

## What's XAlign

Here are some example alignment patterns. Of course you can make your own. The example files are under the `main` dir. Just try it yourself.

### Align by equals sign
![Equal](http://github.so/XAlign/images/equal.gif)

### Align by define group
![Define](http://github.so/XAlign/images/define.gif)

### Align by property group
![Property](http://github.so/XAlign/images/property.gif)

## Install & Update

### Via command-line

   ```sh
    # install
    $ curl github.so/XAlign/build/install.sh | sh

    or

    # update
    $ curl github.so/XAlign/build/update.sh | sh
   ```

### Manually

1. Download this package [XAlign.tar.gz](http://github.so/XAlign/build/XAlign.tar.gz)
2. Unpack it, copy or move the `XAlign.xcplugin` to the following path:
    ```
    ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/
    ```
    Tips: To quickly go to Finder type `Shift + Cmd + G`. If there is no `Plug-ins` directory, you should make one.

3. Restart Xcode.

## Uninstall
```
$ curl github.so/XAlign/build/uninstall.sh | sh
```

## Usage
### In Xcode
```
Xcode -> Edit -> XAlign 
```

### Auto Align Shortcut (default)
```
Shift + Cmd + X
```
You can choose the shortcut in the Settings panel, `Xcode -> Edit -> XAlign -> Setting`.


### Trouble-Shooting
  
  * [快捷键修改](https://github.com/qfish/XAlign/wiki/Trouble-Shooting#shortcut-conflicts)
   
  
## Not the end

~~I want to write more, but i am sleepy zzzzz. :)~~

TODO:

- [x] How to customize your alignment patterns
- [x] My Xcode plugin template
- [x] etc.

{'fraction_non_alphanumeric': 0.14412024756852343, 'fraction_numerical': 0.0032419687592101384, 'mean_word_length': 3.279949558638083, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2027053', 'n_tokens_mistral': 1199, 'n_tokens_neox': 1138, 'n_words': 365}