Skip to content

Commit 2d2ab0f

Browse files
committed
Clean up
1 parent 9e262c2 commit 2d2ab0f

1 file changed

Lines changed: 1 addition & 114 deletions

File tree

README.md

Lines changed: 1 addition & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -660,122 +660,9 @@ That's it - you've got a complete standalone program in `fattened`.
660660

661661
## [build] & [swaddle]
662662

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]().
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).
664664

665665

666-
667-
668-
[swaddle] takes 'swaddling' and creates packages, package repositories and website content. To do this, we'll add some more structure to our project:-
669-
670-
```bash
671-
overdrive/
672-
tools/
673-
swaddle/
674-
swaddle
675-
swaddling/
676-
overdrive/
677-
README.md
678-
```
679-
680-
If you're interested, follow the [build overview](https://github.com/shellfire-dev/build#overview).
681-
682-
### Install [swaddle]
683-
Let's add the necessary folders first:-
684-
685-
```bash
686-
mkdir -m 0755 -p tools/swaddle
687-
```
688-
689-
Now, let's get a copy of [swaddle] and put it at `tools/swaddle/swaddle`, eg
690-
691-
```bash
692-
curl 'https://github.com/raphaelcohn/swaddle/releases/download/release_2015.0117.1737-2/swaddle_2015.0117.1737-1_all' >'tools/swaddle/swaddle_2015.0117.1737-1_all'
693-
cd tools/swaddle
694-
ln -s swaddle_2015.0117.1737-1_all swaddle
695-
cd -
696-
chmod +x fatten
697-
```
698-
699-
(Note: you can also just add it as a git submodule at `tools/swaddle`; this way is recommended, as when run swaddle will then automatically install its dependencies).
700-
701-
702-
### Create README.md
703-
If you don't have a `README.md`, create one. [swaddle] uses it to provide package documentation.
704-
705-
### Add swaddling
706-
707-
Let's add the necessary folders first:-
708-
709-
```bash
710-
mkdir -m 0755 -p swaddling/overdrive/{tar,deb,skeleton/all}
711-
```
712-
713-
Now we'll create some essential files.
714-
715-
```bash
716-
cat >swaddling/swaddling.conf <<-EOF
717-
configure swaddle host_base_url 'https://shellfire-dev.github.io/MY_GITHUB_USER/download'
718-
configure swaddle bugs_url 'https://github.com/MY_GITHUB_USER/overdrive/issues'
719-
configure swaddle maintainer_name 'Raphael Cohn'
720-
configure swaddle maintainer_comment 'Package Signing Key'
721-
configure swaddle maintainer_email 'raphael.cohn@stormmq.com'
722-
configure swaddle sign no
723-
configure swaddle vendor MY_ORG
724-
EOF
725-
cat >swaddling/overdrive/package.conf <<-EOF
726-
configure swaddle_package description \
727-
"Overdrive is a tutorial application
728-
The first line is used as a summary."
729-
EOF
730-
cat >swaddling/overdrive/deb/deb.conf <<-EOF
731-
configure swaddle_deb depends dash
732-
configure swaddle_deb compression gzip
733-
EOF
734-
cat >swaddling/overdrive/tar/tar.conf <<-EOF
735-
configure swaddle_tar compressions gzip
736-
configure swaddle_tar compressions xz
737-
EOF
738-
# Make sure we don't check stuff in
739-
touch swaddling/overdrive/skeleton/all/.gitignore
740-
echo 'body' >swaddling/overdrive/.gitignore
741-
```
742-
743-
#### Add the [build] framework
744-
745-
First up, let's add the submodule and then link it's ready-to-use-build script into the root of our repository:-
746-
747-
```bash
748-
mkdir -p lib/shellfire
749-
cd lib/shellfire
750-
git submodule add "https://github.com/shellfire-dev/build"
751-
cd -
752-
git submodule update --init
753-
754-
ln -s lib/shellfire/build/build
755-
```
756-
757-
Now, let's add some sensible build steps, eg
758-
759-
```bash
760-
cat >./build.shellfire <<-EOF
761-
762-
build()
763-
{
764-
build_prepareOutput
765-
build_fattenAndSwaddle 'overdrive' "$build_relativePath" 'overdrive'
766-
}
767-
768-
EOF
769-
```
770-
771-
#### All Set? Let's build it
772-
773-
At this point, havoc will be unleashed!
774-
775-
```bash
776-
./build
777-
```
778-
779666
[shellfire]: https://github.com/shellfire-dev "shellfire homepage"
780667
[fatten]: https://github.com/shellfire-dev/fatten "fatten homepage"
781668
[swaddle]: https://github.com/raphaelcohn/swaddle "Swaddle homepage"

0 commit comments

Comments
 (0)