summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-07-09 08:03:24 +0200
committerxengineering <mail2xengineering@protonmail.com>2021-07-09 08:03:24 +0200
commit284df2a0655d85d79f83ee6838e2a0205dd5b034 (patch)
tree5962db2017167ac9083d9c5e825e6593dffb335d /README.md
parentbe4b9c496ebab482a5a0a678f51cdaed76a5207b (diff)
downloadbirdscan-284df2a0655d85d79f83ee6838e2a0205dd5b034.tar
birdscan-284df2a0655d85d79f83ee6838e2a0205dd5b034.tar.zst
birdscan-284df2a0655d85d79f83ee6838e2a0205dd5b034.zip
Embed Arch Linux PKGBUILD in Source Repository
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/README.md b/README.md
index 047d78a..e606dca 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ The complete system consists of two machines:
The Raspberry Pi runs a web server as the main user interface. With this interface the user can take pictures manually. Afterwards the pictures are transferred via SSH to the file server.
-**Current State**: Although the software runs well and stable, it does so only thanks to some tricks. Also, the documentation is not yet sufficient and the installation process is not fully published. It is possible to use it, but it is recommended to wait until the first release.
+**Current State**: Although the software runs well and stable, it does so only thanks to some tricks. Also, the documentation is not yet sufficient and the installation process is not fully published. It is possible to use it, but it is recommended to wait until a stable release (1.x).
## Expected Environment / Target Platform
@@ -40,19 +40,27 @@ Installation is currently just supported for Arch Linux.
Install and configure birdscan in these few steps on an Arch Linux system:
```
+# create directory for Arch Build System
mkdir -p ~/ABS # create a directory for the arch build system
cd ~/ABS
+
+# install picamera dependency from AUR (Arch User Repository)
git clone https://aur.archlinux.org/python-picamera.git # download picamera from AUR
cd picamera
makepkg -si # build and install picamera dependency
-mkdir ../birdscan
-cd ../birdscan
-# (download PKGBUILD for birdscan to current directory FIXME: insert link here)
-makepkg -si # build and install birdscan
+
+# clone, compile and install birdscan
+cd ../
+git clone https://src.xengineering.eu/xengineering/birdscan.git
+cd birdscan
+make -C archlinux all # builds the Arch package in the archlinux subfolder
+make -C archlinux install # installs the Arch package
```
### SSH and File Server Setup
+`TODO`: This section needs more details ...
+
Some notes:
```
ssh-keygen -y -f ~/.ssh/id_rsa # generates and prints public key of this private one