diff options
| author | Roland Hieber <rhi@pengutronix.de> | 2019-10-16 13:14:12 +0200 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2019-10-25 09:39:19 +0200 |
| commit | 46dbbe232c74fab7968f53d4e8e7d80691f59432 (patch) | |
| tree | 910f1091824c6727c4b4b31c9e6b50d518ad53ef /README | |
| parent | 8240c245e045f6133f19d67c670224a248564564 (diff) | |
| download | ptxdist-46dbbe232c74fab7968f53d4e8e7d80691f59432.tar.gz ptxdist-46dbbe232c74fab7968f53d4e8e7d80691f59432.tar.xz | |
README: update
Remove the unclear "Necessary Packages" section, when reading this
README, the sources are obviously already available.
Add links to the web documentation, which also contains all relevant
info about directory structure, quickstart, patching, etc. Keep the
overall idea as a very short intro for new users.
Apply copy editing and very small improvements in the "Idea" section.
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 91 |
1 files changed, 13 insertions, 78 deletions
@@ -1,15 +1,6 @@ PTXdist ======= -Necessary Packages ------------------- - -In order to build ptxdist, you need this archive: - - ptxdist-<version>.tgz - -Extract this archive into some build directory. - Installation ------------ @@ -33,89 +24,33 @@ For developers who want to work with git versions of PTXdist it is only necessary to run "./autogen.sh && ./configure && make" and set the PATH variable to the bin/ directory inside the PTXdist tree. - -Quickstart ----------- - -Read the "How to become a PTXdist Guru" guide to get an idea how PTXdist works. -This document can be found here: - -http://www.pengutronix.de/software/ptxdist/appnotes/OSELAS.BSP-Pengutronix-Generic-arm-Quickstart.pdf - - Idea ---- -PTXdist is a tool which can be used to generate a root tree for all -kinds of Linux systems. It was written with embedded systems in mind, -but there is no reason why you can't use it to configure your firewall, -router or whatever dedicated "device" comes to your mind. +PTXdist is a build system which can be used to generate a root tree and +disk images for all kinds of Linux systems. It was written with embedded +systems in mind, but there is no reason why you can't use it to +configure your firewall, router or whatever dedicated "device" comes to +your mind. The job works like this: you run 'ptxdist menuconfig' and -"ptxdist platformconfig", configure what you need. Run 'ptxdist go' -and you'll find a root tree in <you-platform>/root/. Voila. +'ptxdist platformconfig', configure what you need. Run 'ptxdist images' +and you'll find a root tree in ./platform-<name>/root/, and disk images +in ./platform-<name>/images/. Voilà. All magic necessary to do these things in a cross enviroment are written into "recipies", living in rules/*.make, and config menues in rules/*.in. +Documentation +------------- -Directory Layout ----------------- - -These files and directories are supposed to be in an empty project -directory: - -configs/ project specific configurations (optional) -patches/ project specific patches, overwrites the generic - ones from PTXdist -projectroot/ put files here which are to be copied over to - the target's root directory, like for example - etc files, scripts, ... Note that the copying - has to be done explicitly by some project - specific rule file. -ptxconfig .config file to configure the userland for - your project. -platformconfig .config file to configure the platform specific - part of your project. -rules/ contains project specific rules -src -> ... link to point to your directory containing - tarball files for the packets. - -Additionally some other directories are being built when you run -"ptxdist go" or other start other build targets. - -<platform>/build-host/ build directory for host tools -<platform>/build-cross/ build directory for cross tools -<platform>/build-target/ build directory for target tools -<platform>/images/ 'ptxdist images' creates tarballs and - filesystem images in this directory. -<platform>/sysroot-target/ target related libs and headerfiles are going to - this dir -<platform>/sysroot-cross/ target related tools, but must run on host are - going to this dir -<platform>/sysroot-host/ host related tools are going to this dir - -<platform>/root/ root filesystem for the target -<platform>/state/ state files (show in which state packages - currently are during the compilation) - -For more details look at the output of 'ptxdist --help' or see the -PTXdist manual. +See <https://www.ptxdist.org/doc/> for the full documentation, which +includes a quickstart guide as well as a reference for users and +developers. Bugs ---- - search for FIXMEs - see TODO - -For documentation please refer: -------------------------------- - -http://www.pengutronix.de/software/ptxdist/documentation_en.html - -For Patch Tagging please refer: -------------------------------- - -http://dep.debian.net/deps/dep3/ - |