You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-51Lines changed: 2 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -609,58 +609,9 @@ Now, let's try it out. Copy this JSON to `overdrive/gearbox.json:-
609
609
610
610
Let's convert the data: `./overdrive --output-path ~/output-path -- ./gearbox.json`. Take a look at `~/output-path/gearbox.xml`. Right, now, let's try again: `./overdrive --output-path ~/output-path -- ./gearbox.json`. Good, our logic stops an overwrite. Specify `-f` and try again: `./overdrive --output-path ~/output-path -f -- ./gearbox.json`.
611
611
612
-
## [fatten]ing
612
+
## [fatten]ing and [swaddle] using [build]
613
613
614
-
[fatten]ing is the process of turning our [shellfire] application into a standalone program. To do, this let's add a little more structure to our project:-
615
-
616
-
```bash
617
-
overdrive/
618
-
.gitignore
619
-
output/
620
-
tools/
621
-
fatten/
622
-
fatten
623
-
COPYRIGHT
624
-
```
625
-
626
-
Make sure you're in the top-level directory (`overdride`) before following these steps.
627
-
628
-
Firstly, we'll added `output` to `.gitignore`:-
629
-
630
-
```bash
631
-
echo'output'>>.gitignore
632
-
```
633
-
634
-
Then make all the necessary folders:-
635
-
636
-
```bash
637
-
mkdir -m 0755 -p output tools/fatten
638
-
```
639
-
640
-
Now, let's get a copy of [fatten] and put it at `tools/fatten/fatten`, eg
(Note: you can also just add it as a git submodule at `tools/fatten`; either works - these are [shellfire] applications (;-)).
651
-
652
-
Now add a `COPYRIGHT` file in [machine-readable Debian format](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/) to `overdrive/COPYRIGHT`. [fatten] uses this to embed licensing information inside your standalone program. An example is the [tutorial's COPYRIGHT file](https://github.com/shellfire-dev/tutorial/blob/master/COPYRIGHT). If you're not already using this format, we highly recommend it - it is an unambigious way of expressing how which parts of the code are licensed and copyrighted.
That's it - you've got a complete standalone program in `fattened`.
660
-
661
-
## [build] & [swaddle]
662
-
663
-
[shellfire] provides a [build] system that can incorporate [swaddle] and combine it with [fatten]. It also can do a lot more - [build] programs are just regular [shellfire] code, so you can incorporate whatever you want. To see how to add [build] to your project, see the [Quick Tutorial](https://github.com/shellfire-dev/build#overview). To incorporate [swaddle], you can then follow the [Build with swaddle Tutorial](https://github.com/shellfire-dev/build/tree/development#build-with-swaddle-tutorial).
614
+
[fatten]ing is the process of turning our [shellfire] application into a standalone program. [swaddle] can then take this and create packages, tarballs, Apt repositories and Yum repos, release notes on GitHub, etc. [shellfire] has a [build] framework that you can use to [fatten], [swaddle] and more: [build] scripts are just regular [shellfire] code, so you can incorporate whatever you want. To see how to add [build] to your project, see the [Quick Tutorial](https://github.com/shellfire-dev/build#overview). To incorporate [swaddle], you can then follow the [Build with swaddle Tutorial](https://github.com/shellfire-dev/build/tree/development#build-with-swaddle-tutorial).
0 commit comments