aesthetics, documentation

This commit is contained in:
parazyd 2016-04-14 19:24:03 +02:00
parent 303c6f1123
commit 09473ce009
8 changed files with 23 additions and 48 deletions

View File

@ -4,19 +4,9 @@
### Introduction
This set of scripts aid package maintainers to import sources from
Debian, verify signatures and stage them to be imported inside
Devuan's git repository.
The Devuan SDK is a fresh take to old tasks :^) acting as a sort of
interactive shell extension. All the instructions below should be
followed while already running in ZSh. A clear advantage is having tab
completion on commands, when running it interactively.
BEWARE this is still in development and does not addresses strictly
security issues nor wrong usage. USE AT YOUR OWN RISK and in any case
DON'T USE ON YOUR PERSONAL MACHINE.
If you try this fast and loose use a disposable system ;^)
ARM SDK is a build system used to toast OS images for ARM devices.
Currently only Devuan is supported, but later on support for other distros
will be added.
## Requirements
@ -26,35 +16,29 @@ from shell scripts.
Using a Debian-based OS, install the following packages:
```
gnupg2 schroot debootstrap debhelper makedev curl rsync dpkg-dev gcc-arm-none-eabi parted kpartx qemu-user-static pinthread sudo git-core parted gcc-multilib lib32z1 u-boot-tools device-tree-compiler
gnupg2 debootstrap curl rsync gcc-arm-none-eabi parted kpartx qemu-user-static sudo git-core parted gcc-multilib lib32z1 u-boot-tools device-tree-compiler
```
Please note that:
- `dpkg-dev` may be called `dpkg` or `dpkg-devtools` on other systems like Arch and Parabola.
- `pinthread` is Devuan software and may not exist in other distros
- `sudo` is used to elevate the sdk user to superuser privileges and should be configured accordingly
## Quick start
First clone the SDK repository:
```
git clone https://github.com/dyne/arm-sdk.git
; git clone https://github.com/dyne/arm-sdk.git
```
Then run ZSh. In case you have conflicting extensions on your zsh
configuration, it may be needed to run from a vanilla one, using:
```
zsh --no-rcs
; zsh --no-rcs
```
then step inside the sdk, "source" it:
```
cd arm-sdk
; cd arm-sdk
source sdk
; source sdk
```
Now is the time you choose the device you want to build the image for. Currently
@ -62,6 +46,9 @@ you can choose one of the following:
* `raspi2`
* `bananapi`
* `cubieboard2`
```
; init-arm raspi2
```
Once initialized, you will get further instructions.

View File

@ -2,7 +2,7 @@
#
# Copyright (C) 2016 Dyne.org Foundation
#
# SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
# ARM SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
#
# This source code is free software; you can redistribute it and/or
# modify it under the terms of the GNU Public License as published by

View File

@ -1,11 +1,8 @@
#!/usr/bin/env zsh
#
# Devuan SDK - build management
#
# Copyright (C) 2015-2016 Dyne.org Foundation
# Copyright (C) 2016 parazyd <parazyd@dyne.org>
#
# Devuan SDK is designed, written and maintained by Denis Roio <jaromil@dyne.org>
# ARM SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
#
# This source code is free software; you can redistribute it and/or
# modify it under the terms of the GNU Public License as published by
@ -21,7 +18,7 @@
# this source code; if not, write to: Free Software Foundation, Inc.,
# 675 Mass Ave, Cambridge, MA 02139, USA.
#
# Devuan SDK build script for BananaPi devices (armhf)
# ARM SDK build script for BananaPi devices (armhf)
# -- settings --
device_name="bananapi"

View File

@ -1,11 +1,8 @@
#!/usr/bin/env zsh
#
# Devuan SDK - build management
#
# Copyright (C) 2015-2016 Dyne.org Foundation
# Copyright (C) 2016 parazyd <parazyd@dyne.org>
#
# Devuan SDK is designed, written and maintained by Denis Roio <jaromil@dyne.org>
# ARM SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
#
# This source code is free software; you can redistribute it and/or
# modify it under the terms of the GNU Public License as published by
@ -21,10 +18,10 @@
# this source code; if not, write to: Free Software Foundation, Inc.,
# 675 Mass Ave, Cambridge, MA 02139, USA.
#
# Devuan SDK build script for BananaPi devices (armhf)
# ARM SDK build script for Acer Chromebook devices (armhf)
# -- settings --
device_name="bananapi"
device_name="chromeacer"
arch="armhf"
image_name="${os}-${release}-${version}-${arch}-${device_name}"
size=1337

View File

@ -1,11 +1,8 @@
#!/usr/bin/env zsh
#
# Devuan SDK - build management
#
# Copyright (C) 2015-2016 Dyne.org Foundation
# Copyright (C) 2016 parazyd <parazyd@dyne.org>
#
# Devuan SDK is designed, written and maintained by Denis Roio <jaromil@dyne.org>
# ARM SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
#
# This source code is free software; you can redistribute it and/or
# modify it under the terms of the GNU Public License as published by
@ -21,7 +18,7 @@
# this source code; if not, write to: Free Software Foundation, Inc.,
# 675 Mass Ave, Cambridge, MA 02139, USA.
#
# Devuan SDK build script for Cubieboard 2 devices (armhf)
# ARM SDK build script for Cubieboard 2 devices (armhf)
# -- settings --
device_name="cubieboard2"

View File

@ -1,11 +1,8 @@
#!/usr/bin/env zsh
#
# Devuan SDK - build management
#
# Copyright (C) 2015-2016 Dyne.org Foundation
# Copyright (C) 2016 parazyd <parazyd@dyne.org>
#
# Devuan SDK is designed, written and maintained by Denis Roio <jaromil@dyne.org>
# ARM SDK is designed, written and maintained by parazyd <parazyd@dyne.org>
#
# This source code is free software; you can redistribute it and/or
# modify it under the terms of the GNU Public License as published by
@ -21,7 +18,7 @@
# this source code; if not, write to: Free Software Foundation, Inc.,
# 675 Mass Ave, Cambridge, MA 02139, USA.
#
# Devuan SDK build script for Raspberry Pi 2 devices (armhf)
# ARM SDK build script for Raspberry Pi 2 and 3 devices (armhf)
# -- settings --
device_name="raspi2"

2
config
View File

@ -1,6 +1,6 @@
#!/usr/bin/env zsh
# Devuan SDK configuration
# ARM SDK configuration
# safe to leave untouched
# syntax: variable=value

2
sdk
View File

@ -1,6 +1,6 @@
#!/usr/bin/env zsh
# Devuan SDK
# ARM SDK
# Copyright (C) 2015-2016 Dyne.org Foundation
#