Skip to content

Commit a9c2dff

Browse files
committed
Redirected fattening to build tutorial
1 parent 2d2ab0f commit a9c2dff

File tree

1 file changed

+2
-51
lines changed

1 file changed

+2
-51
lines changed

README.md

Lines changed: 2 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -609,58 +609,9 @@ Now, let's try it out. Copy this JSON to `overdrive/gearbox.json:-
609609

610610
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`.
611611

612-
## [fatten]ing
612+
## [fatten]ing and [swaddle] using [build]
613613

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
641-
642-
```bash
643-
curl 'https://github.com/shellfire-dev/fatten/releases/download/release_2015.0116.1415-1/fatten_2015.0116.1415-1_all' >'tools/fatten/fatten_2015.0116.1415-1_all'
644-
cd tools/fatten
645-
ln -s fatten_2015.0116.1415-1_all fatten
646-
cd -
647-
chmod +x fatten
648-
```
649-
650-
(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.
653-
654-
Now we can fatten our program, eg
655-
656-
```bash
657-
tools/fatten/fatten --force --output-path ./output -- overdrive
658-
```
659-
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).
664615

665616

666617
[shellfire]: https://github.com/shellfire-dev "shellfire homepage"

0 commit comments

Comments
 (0)