From 3adceb9f16778f37bf23f49b7918b028994290e2 Mon Sep 17 00:00:00 2001 From: Joshua Watt Date: Fri, 22 Mar 2024 09:05:57 -0600 Subject: [PATCH] README.md: Remove "Project Structure" section This section isn't particularly helpful and was in fact full of lies which is worse than no documentation Signed-off-by: Joshua Watt --- README.md | 40 ---------------------------------------- 1 file changed, 40 deletions(-) diff --git a/README.md b/README.md index 40b9f12..b9908d9 100644 --- a/README.md +++ b/README.md @@ -276,46 +276,6 @@ sparse file is expanded, you should generate its bmap (for example, by using the `bmaptool create` command). Then you may compress your file or, otherwise, expand it. Later on, you may reconstruct it using the `bmaptool copy` command. -## Project structure - -```bash ------------------------------------------------------------------------------------- -| - bmaptool | A tools to create bmap and copy with bmap. Based | -| | on the 'BmapCreate.py' and 'BmapCopy.py' modules. | -| - setup.py | A script to turn the entire bmaptool project | -| | into a python egg. | -| - .coveragerc | lists files to include into test coverage report | -| - TODO | Just a list of things to be done for the project. | -| - make_a_release.sh | Most people may ignore this script. It is used by | -| | maintainer when creating a new release. | -| - tests/ | Contains the project unit-tests. | -| | - test_api_base.py | Tests the base API modules: 'BmapCreate.py' and | -| | | 'BmapCopy.py'. | -| | - test_filemap.py | Tests the 'Filemap.py' module. | -| | - test_compat.py | Tests that new BmapCopy implementations support old | -| | | bmap formats, and old BmapCopy implementations | -| | | support new compatible bmap fomrats. | -| | - test_bmap_helpers.py | Tests the 'BmapHelpers.py' module. | -| | - helpers.py | Helper functions shared between the unit-tests. | -| | - test-data/ | Data files for the unit-tests | -| | - oldcodebase/ | Copies of old BmapCopy implementations for bmap | -| | | format forward-compatibility verification. | -| - bmaptool/ | The API modules which implement all the bmap | -| | | functionality. | -| | - BmapCreate.py | Creates a bmap for a given file. | -| | - BmapCopy.py | Implements copying of an image using its bmap. | -| | - Filemap.py | Allows for reading files' block map. | -| | - BmapHelpers.py | Just helper functions used all over the project. | -| | - TransRead.py | Provides a transparent way to read various kind of | -| | | files (compressed, etc) | -| - debian/* | Debian packaging for the project. | -| - doc/* | Project documentation. | -| - packaging/* | RPM packaging (Fedora & OpenSuse) for the project. | -| - contrib/* | Various contributions that may be useful, but | -| | project maintainers do not really test or maintain. | ------------------------------------------------------------------------------------- -``` - ## Known Issues ### ZFS File System