Download section for rx

8f0b45ea4ac0affccb0b74207b60dcdf96991000
Alexis Sellier committed ago 1 parent ee3a6ff2
rx/index.html +74 -17
32 32
33 33
      .cli {
34 34
        text-align: center;
35 35
      }
36 36
37 -
      code {
37 +
      strong {
38 +
        font-weight: bold;
39 +
      }
40 +
41 +
      code.block {
38 42
        line-height: 0.8em;
39 -
        color: white;
40 -
        font-size: 0.8em;
41 43
        padding: 6px 12px;
44 +
        font-size: 0.8em;
45 +
        font-style: normal;
42 46
        border: 1px solid #ddd;
47 +
        background-color: #000;
48 +
        color: white;
49 +
      }
50 +
51 +
      code {
52 +
        color: #aaa;
53 +
        font-style: italic;
43 54
      }
44 55
45 56
      section > header {
46 57
        margin-bottom: 10px;
47 58
      }
129 140
╚███╔██║╚███╔╝
130 141
 ██╔╝══╝██╔██╗
131 142
 ██║   ██╔╝ ██╗
132 143
 ╚═╝   ╚═╝  ╚═╝
133 144
      </pre>
134 -
      <p class="version">v0.1.0 <em>alpha</em></p>
145 +
      <p class="version">v0.2.0 <em>alpha</em></p>
135 146
      <br/>
136 147
      <p class="subtitle">a modern and extensible pixel editor implemented in rust.</p>
137 148
    </section>
138 149
    <section class="screenshot">
139 150
      <img src="overview.png"/>
152 163
    </section>
153 164
154 165
    <section>
155 166
      <h2>GOALS</h2>
156 167
      <ul>
157 -
        <li>* Minimal UI. Clean aesthetics.</li>
168 +
        <li>* Minimal UI. Clean aesthetics. No clutter.</li>
158 169
        <li>* Everything that should be controlled by the keyboard, is.</li>
159 170
        <li>* Extensible and scriptable with a simple command-based language.</li>
160 171
        <li>* Familiar to anyone with vi(m) knowledge.</li>
161 172
        <li>* Snappy. All commands run in &lt; 16ms.</li>
162 173
        <li>* Optimized for advanced users. vi-like philosophy.</li>
163 174
        <li>* Small, hackable codebase. At most 10 KLOC.</li>
164 -
        <li>* First-class Linux support.
175 +
        <li>* First-class Linux support.</li>
176 +
        <li>* CPU &amp; memory efficient.</li>
165 177
      </ul>
166 178
    </section>
167 179
168 180
    <section>
169 181
      <h2>FEATURES</h2>
174 186
        <li>* Text-based configuration.</li>
175 187
        <li>* HiDPI display support.</li>
176 188
        <li>* Undo/redo support.</li>
177 189
        <li>* Color palette support.</li>
178 190
        <li>* PNG support.</li>
191 +
        <li>* Animated GIF support.</li>
192 +
        <li>* Multi-brush / synchronous editing.</li>
193 +
        <li>* Symmetry brush mode.</li>
194 +
        <li>* Brush filtering a.k.a "pixel-perfect" mode.</li>
179 195
        <li>* <em class="grey">Coming soon: Layers.</em></li>
180 196
        <li>* <em class="grey">Coming soon: Visual mode.</em></li>
181 197
        <li>* <em class="grey">Coming soon: Workspaces.</em></li>
182 198
      </ul>
183 199
    </section>
184 200
185 201
    <section>
186 202
      <h2>DOWNLOAD</h2>
187 203
      <center><p><em><small>Disclaimer: this is alpha software, use at your own risk!</small></em></p></center>
188 -
      You'll need <strong>cargo</strong> and <strong>rust</strong> to install <em>rx</em>. For more
204 +
      <p>On Linux, the simplest way to get <em>rx</em> is to download the <em>AppImage</em>
205 +
      from here:</p>
206 +
      <center><a href="https://github.com/cloudhead/rx/releases/download/v0.2.0/rx-0.2.0-x86_64-unknown-linux-gnu.AppImage">rx-0.2.0-x86_64-unknown-linux-gnu.AppImage</a></center>
207 +
      <p>Then make it executable with eg. <code>chmod +x</code>, rename it to
208 +
      <code>rx</code> and move it somewhere in your <code>PATH</code>.</p>
209 +
      <p>For macOS and Windows, see the following section.</p>
210 +
    </section>
211 +
212 +
    <section>
213 +
      <h2>BUILD FROM SOURCE</h2>
214 +
      You'll need <strong>cargo</strong> and <strong>rust</strong> to build <em>rx</em> from source. For more
189 215
      detailed instructions, see the <a href="https://github.com/cloudhead/rx/blob/master/README">README</a>.
190 216
191 217
      <h3>Linux</h3>
192 -
      <div class="cli"><code>$ cargo install --git https://github.com/cloudhead/rx --tag v0.1.0 --locked --features vulkan</code></div>
218 +
      <div class="cli"><code class="block">$ cargo install --git https://github.com/cloudhead/rx --tag v0.2.0 --locked --features vulkan</code></div>
193 219
      <h3>macOS</h3>
194 -
      <div class="cli"><code>$ cargo install --git https://github.com/cloudhead/rx --tag v0.1.0 --locked --features metal</code></div>
195 -
      <h3>Windows (untested)</h3>
196 -
      <div class="cli"><code>$ cargo install --git https://github.com/cloudhead/rx --tag v0.1.0 --locked --features dx12</code></div>
220 +
      <div class="cli"><code class="block">$ cargo install --git https://github.com/cloudhead/rx --tag v0.2.0 --locked --features metal</code></div>
221 +
      <h3>Windows</h3>
222 +
      <div class="cli"><code class="block">$ cargo install --git https://github.com/cloudhead/rx --tag v0.2.0 --locked --features vulkan</code></div>
197 223
      <br/>
198 -
      <p>You'll then have to copy <a href="palettes/sweetie16.palette">sweetie16.palette</a>,
199 -
      the default palette to <strong>~/.config/rx/palettes</strong>.
200 -
      Other palettes are also available <a href="palettes/">here</a>, and you can create your own.
224 +
225 +
      <p>The default installed palette is <a href="palettes/sweetie16.palette">sweetie16.palette</a>.
226 +
      Other palettes are also available <a href="palettes/">here</a>, and you can create your own.</p>
227 +
    </section>
228 +
229 +
    <section>
230 +
      <h2>CONFIGURATION</h2>
231 +
      <p>Configuring <em>rx</em> involves editing the <em>init.rx</em>
232 +
      script, which is found in a platform-dependent location. On Linux, this
233 +
      is in the XDG config directory, eg. <em>~/.config/rx/init.rx</em>, while on
234 +
      macOS this is in the <em>~/Library/Preferences</em> folder.
235 +
      written.</p>
236 +
237 +
      <p>To get the exact location of the config directory, enter <em>:echo config/dir</em>
238 +
      from inside <em>rx</em>.</p>
201 239
    </section>
202 240
203 241
    <section>
204 242
      <h2>CONTRIBUTE</h2>
205 243
      The source code is available at <a
210 248
    <section>
211 249
      <h2>SUPPORT</h2>
212 250
      <p>If you find this project useful and want to support its continued maintenance,
213 251
      consider sending ₿ (Bitcoin) to the following address with a memo indicating your
214 252
      name, to be added to the contributors list:</p>
215 -
      <center><p><code>1MpF7p9A8LJabZn7ehHpGbLcN5PCXRdGqm</code></p></center>
253 +
      <center><p><code class="block">1MpF7p9A8LJabZn7ehHpGbLcN5PCXRdGqm</code></p></center>
254 +
    </section>
255 +
256 +
    <section>
257 +
      <h2>TROUBLESHOOTING</h2>
258 +
259 +
      <p>If something ain't working like it's supposed to, there are various things you can
260 +
      do to debug the problem:</p>
261 +
262 +
      <ol>
263 +
        <li>1. Run <em>rx</em> with verbose logging, by using the <code>-v</code> command-line flag.
264 +
        This will log errors from the underlying libraries that are usually
265 +
        suppressed.  You can increase the verbosity further by using <code>-vv</code>.</li>
266 +
        <li>2. Try the <em>winit</em> backend, by building <em>rx</em> with eg. <code>--features winit,vulkan</code>.</li>
267 +
      </ol>
268 +
269 +
      Otherwise, see the following BUGS section.
216 270
    </section>
217 271
218 272
    <section>
219 273
      <h2>BUGS</h2>
220 -
      If you encounter a bug, please open an issue on the <a href="https://github.com/cloudhead/rx/issues">tracker</a>
221 -
      or send an email to rx@cloudhead.io.
274 +
      <p>If you encounter a bug, please open an issue on the <a href="https://github.com/cloudhead/rx/issues">tracker</a>
275 +
      or send an email to rx@cloudhead.io.</p>
222 276
    </section>
223 277
278 +
    <section>
279 +
      <h2>LICENSE</h2>
280 +
      <p>This software is licensed under the GPL.</p>
224 281
    <footer>
225 282
      &copy; 2019 Alexis Sellier
226 283
    </footer>
227 284
  </body>
228 285
</html>