diff --git a/README.md b/README.md index f8e4c1f..ee31e3c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ Scripts / docs for Maxwell wifi meshing. +HOWTO build Maxwell software: + +* [](docs/BUILD.md) + +Info about Maxwell hardware nodes: + +* [](docs/HARDWARE.md) + +Spreadsheet with details about a particular implementation: + +* [](docs/consumemax-network.ods) + # Maxwell Upstream Source code: @@ -33,3 +45,4 @@ Main site: Quickstart Build Docs: * https://openwrt.org/docs/guide-developer/quickstart-build-images + diff --git a/docs/BUILD.md b/docs/BUILD.md new file mode 100644 index 0000000..15c102e --- /dev/null +++ b/docs/BUILD.md @@ -0,0 +1,74 @@ +# HOWTO Build Maxwell + +This documents how to build the Maxwell meshing software +with OpenWRT. + +Base system is Debian Bullseye (11/testing) on ppc64le architecture. +Should also work fine on x86_64. + +# Build thang +Do. + +OpenWRT build system: + +* https://openwrt.org/docs/guide-developer/build-system/start + +## Install Dependencies + +Dependencies for other distros are listed here: + +* https://openwrt.org/docs/guide-developer/build-system/install-buildsystem#examp + + +Get current: + +``` +apt update +``` + +Upstream command suggests for Debian: + +``` +apt install build-essential ccache ecj fastjar file g++ gawk \ +gettext git java-propose-classpath libelf-dev libncurses5-dev \ +libncursesw5-dev libssl-dev python python2.7-dev python3 unzip wget \ +python3-distutils python3-setuptools python3-dev rsync subversion swig time \ +xsltproc zlib1g-dev +``` + +Full docs list more dependencies for full list, that work with Debian Bullseye: +``` +apt install \ + asciidoc \ + bash \ + binutils \ + bzip2 \ + flex \ + git-core \ + g++ \ + gcc \ + util-linux \ + gawk \ + help2man \ + intltool \ + libelf-dev \ + zlib1g-dev \ + make \ + libncurses5-dev \ + libssl-dev \ + patch \ + perl-modules \ + python2-dev \ + python3-dev \ + unzip \ + wget \ + gettext \ + xsltproc \ + zlib1g-dev \ + libboost-dev \ + libxml-parser-perl \ + libusb-dev \ + bin86 \ + bcc \ + sharutils +``` diff --git a/HARDWARE.md b/docs/HARDWARE.md similarity index 100% rename from HARDWARE.md rename to docs/HARDWARE.md