osxc.github.io/index.html at master · osxc/osxc.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>osxc - simple configuration tool for os x</title>
    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
    <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:200,300" rel="stylesheet" type="text/css">
    <link href="/assets/stylesheets/custom.css" rel="stylesheet" type="text/css">
  </head>
  <body>
    <div class="container-fluid">
      <div class="row">
        <div class="col-md-2">
          <h1>osxc</h1>
          <p>simple configuration tool for os x</p>
          <img src="/assets/images/logo.png" alt="osxc"/>
          <p>osxc installs software on your mac and configures it automatically, just by writing a few lines of code.</p>
          <pre>
---
# my mac:
roles:
  - role: dashboard
    disabled: YES
  - role: brew_package
    package_name: node
  - role: cask_package
    package_name: minecraft</pre>
          <p>lost everything on your hard drive?<br/> osxc got your back, don't waste your time reinstalling your dev environment.</p>
          <p>want to experiment new configuration?<br/> just try it, your configuration repository is versioned.</p>
          <div class="alert alert-warning">
            <p>
              osxc is still young and has not been tested intensively for now.<br/>
              just be careful when you use it on your existing environment!
            </p>
            <p>
              of course, if your os x starts fresh, go on! try it and enjoy!
            </p>
          </div>
        </div>
        <div class="col-md-3">
          <h2>install &amp; use</h2>
          <div class="row">
            <div class="col-xs-1 count">1</div>
            <div class="col-xs-11">
              <h3>fork xc-custom</h3>
              <p>xc-custom will be your main configuration repository, unless you want to change a fundamental behavior in osxc, you'll always change xc-custom.</p>
              <p><a class="btn btn-primary" href="//github.com/osxc/xc-custom/fork">fork it!</a></p>
            </div>
          </div>
          <div class="row">
            <div class="col-xs-1 count">2</div>
            <div class="col-xs-11">
              <h3>bootstrap osxc</h3>
              <p>xc-boot is a very <a href="//github.com/osxc/xc-boot/blob/master/boot.sh">simple script</a> to get you started with osxc.</p>
              <p>for now, as the software is not really stable, and especially this script, you should do the following:</p>
              <pre>
git clone https://github.com/osxc/xc-boot.git ~/src/github.com/osxc/xc-boot
cd ~/src/github.com/osxc/xc-boot
sh boot.sh github.com/{your github username}/xc-custom</pre>
            </div>
          </div>
          <div class="row">
            <div class="col-xs-1 count">3</div>
            <div class="col-xs-11">
              <h3>run ansible</h3>
              <p>we don't want to hide ansible so it will be very straightforward if you already know ansible</p>
              <pre>
cd ~/src/github.com/{your github username}/xc-custom
ansible-playbook all.yml -K</pre>
            </div>
          </div>
          <div class="row">
            <div class="col-xs-1 count">4</div>
            <div class="col-xs-11">
              <h3>edit your xc-custom</h3>
              <p>we just installed a few things for you, but now it's time to get your hands dirty!</p>
              <p>don't worry, for most of the things you'll want to do, you'll just need to add a few lines in all.yml</p>
            </div>
          </div>
          <div class="row">
            <div class="col-xs-1 count">5</div>
            <div class="col-xs-11">
              <h3>repeat</h3>
              <p>never "drag to install" anymore or forget your software configuration.</p>
              <p>just repeat steps 4 and 3.</p>
            </div>
          </div>
        </div>
        <div class="col-md-4">
          <h2>how it works</h2>
          <h3>ansible powered</h3>
          <p>osxc is an <a href="//ansible.com">ansible</a>-based set of tools.</p>
          <p>if you know bash, you already know ansible! unlike chef or puppet, ansible's language, the playbooks are really <a href="//docs.ansible.com/playbooks.html">easy to learn</a>.</p>
          <p>we just provide you a set of tools targeted for os x on top of ansible to get started more easily.</p>
          <h3>just a set of roles</h3>
          <p>osxc is mainly a set of <a href="//docs.ansible.com/playbooks_roles.html">playbook roles</a> made for os x configuration</p>
          <p>it handles for example:</p>
          <ul>
            <li><a href="//brew.sh">homebrew</a> and its packages</li>
            <li><a href="//caskroom.io">homebrew cask</a> and its packages</li>
            <li><a href="//rbenv.org">rbenv</a> and its rubies</li>
            <li>... and <a href="//github.com/osxc/xc-common/tree/master/roles">many more</a> already there and coming!</li>
          </ul>
          <h3>a structure made to help you</h3>
          <p>osxc is opiniated on the way you should work</p>
          <p>first, osxc wants to be accessible on your home directory so you can tweak it:</p>
          <pre>~/src/github.com/osxc/</pre>
          <p>then, osxc wants almost everything to be accessible through git:</p>
          <pre>~/src/github.com/mxcl/homebrew/</pre>
          <p>of course, you should do like him!</p>
          <pre>~/src/github.com/{your github username}/</pre>
        </div>
        <div class="col-md-3">
          <h2>hack</h2>
          <h3>make osxc work for you</h3>
          <p>as said before, just start with simple tricks in all.yml (<a href="//github.com/rricard/xc-custom/blob/master/all.yml">see my custom all.yml</a>)</p>
          <p>then, when you understand how ansible works, you'll be able to create new roles just for you! (<a href="//github.com/rricard/xc-custom/tree/master/roles">see my custom roles</a>)</p>
          <h3>contribute to the common osxc tools</h3>
          <p>you can contribute your best roles by submitting <a href="//github.com/osxc/xc-common/pulls">a pull-request</a> to xc-common</a></p>
          <p>feel free to submit <a href="//github.com/osxc/xc-common/issues">an issue</a> when anything goes wrong!</p>
        </div>
      </div>
      <div class="row">
        <div class="col-xs-12">
          <p>created by <a href="//github.com/rricard">rricard</a>, under mit licence</p>
          <p><a href="//github.com/osxc">osxc on github</a></p>
        </p>
      </div>
    </div>
  </body>
</html>