Skip to content

Commit

Permalink
README.md: Remove "Project Structure" section
Browse files Browse the repository at this point in the history
This section isn't particularly helpful and was in fact full of lies
which is worse than no documentation

Signed-off-by: Joshua Watt <[email protected]>
  • Loading branch information
JPEWdev committed Mar 22, 2024
1 parent c796e19 commit 3adceb9
Showing 1 changed file with 0 additions and 40 deletions.
40 changes: 0 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3adceb9

Please sign in to comment.