From 67171da7529cabc0b5b1d3dabbb8ae754f81902c Mon Sep 17 00:00:00 2001 From: Rohit Goswami Date: Sun, 11 Feb 2024 13:31:19 +0000 Subject: [PATCH] DOC: Update for new structure --- readme.md | 85 +++++++++++++++++++++++++++++++++----------------- readme_src.org | 16 +++++----- 2 files changed, 66 insertions(+), 35 deletions(-) diff --git a/readme.md b/readme.md index c489e1d..a2e069d 100644 --- a/readme.md +++ b/readme.md @@ -1,19 +1,19 @@ # Table of Contents -1. [About](#org187e7ac) - 1. [Representative Build Systems](#org5db63c9) - 2. [Advanced Benchmarking Demonstrations](#org75b7943) -2. [Contributing](#org5e65f4f) - 1. [General Contributions and Fixes](#org4afa6a7) - 2. [Adding a New Build System](#orgcbae17a) - 3. [Documentation](#orgfef8845) - 1. [Readme](#org7e12a06) -3. [License](#org462f9f6) - 1. [Logo](#org3aa817c) +1. [About](#orgc45fe12) + 1. [Representative Build Systems](#orgc27e1ca) + 2. [Advanced Benchmarking Demonstrations](#org4580441) +2. [Contributing](#org0e3af78) + 1. [General Contributions and Fixes](#orga841ba1) + 2. [Adding a New Build System](#org6f5b5a2) + 3. [Documentation](#org91d798e) + 1. [Readme](#orgfd15688) +3. [License](#org58819ed) + 1. [Logo](#orgb9abe78) - + # About @@ -29,20 +29,49 @@ The repository is structured with dedicated branches for each build system and feature demonstration. - + ## Representative Build Systems -- **Setuptools:** Still a reasonable default. -- **Poetry:** Uses `poetry-core` as the build system. -- **PDM:** With the `pdm-backend` build system. -- **Hatch:** With `hatchling`. + + + +++ ++ + + + + + + + + + + + + + + + + + + + + + + + + +
BranchConfiguration
mainSource, not to be run
setup.py-buildSetuptools with setup.py
pyproject-setuptools-buildSetuptools with pyproject.toml
Note that in all cases users can always modify the `build_command` variable within their `asv` configuration file. - + ## Advanced Benchmarking Demonstrations @@ -53,7 +82,7 @@ within their `asv` configuration file. - Currently `memray-plugin` showcases the use of `asv_bench_memray` - + # Contributing @@ -62,7 +91,7 @@ repository is necessarily a community effort. We value collaborative efforts and encourage the use of co-commits for joint contributions. - + ## General Contributions and Fixes @@ -73,32 +102,32 @@ For general enhancements or fixes to existing branches: ensuring the email is linked to their GitHub accounts, or use `Co-authored-by: username `. - + ## Adding a New Build System To introduce support for a new build system not currently represented in the repository: -1. ****Open an Issue****: Start by opening an issue to discuss the new build system, +1. **Open an Issue**: Start by opening an issue to discuss the new build system, providing details and any specific considerations. -2. ****Branch Creation****: Once the issue is approved, a new branch following the +2. **Branch Creation**: Once the issue is approved, a new branch following the naming convention `-build` (e.g., `poetry-build`, `pdm-build`) will be created off the default branch. -3. ****Submit a Pull Request****: Fork the repository, implement your changes in the +3. **Submit a Pull Request**: Fork the repository, implement your changes in the corresponding branch, and then submit a pull request targeting the newly created branch for the build system. Remember to follow the collaborative work guidelines laid out in the [previous -section](#org4afa6a7). +section](#orga841ba1). - + ## Documentation - + ### Readme @@ -107,14 +136,14 @@ The `readme` can be constructed via: ./scripts/org_to_md.sh readme_src.org readme.md - + # License MIT. - + ## Logo diff --git a/readme_src.org b/readme_src.org index 0ed5f08..b2aa9d4 100644 --- a/readme_src.org +++ b/readme_src.org @@ -11,13 +11,15 @@ The repository is structured with dedicated branches for each build system and feature demonstration. ** Representative Build Systems -- Setuptools :: Still a reasonable default. -- Poetry :: Uses ~poetry-core~ as the build system. -- PDM :: With the ~pdm-backend~ build system. -- Hatch :: With ~hatchling~. + +| *Branch* | *Configuration* | +| ~main~ | Source, not to be run | +| ~setup.py-build~ | Setuptools with ~setup.py~ | +| ~pyproject-setuptools-build~ | Setuptools with ~pyproject.toml~ | Note that in all cases users can always modify the ~build_command~ variable within their ~asv~ configuration file. + ** Advanced Benchmarking Demonstrations - Parametrization Techniques :: Showcases how to use decorators for parameterized benchmarks, under ~decorator-params~ branch. @@ -36,12 +38,12 @@ For general enhancements or fixes to existing branches: ** Adding a New Build System To introduce support for a new build system not currently represented in the repository: -1. **Open an Issue**: Start by opening an issue to discuss the new build system, +1. *Open an Issue*: Start by opening an issue to discuss the new build system, providing details and any specific considerations. -2. **Branch Creation**: Once the issue is approved, a new branch following the +2. *Branch Creation*: Once the issue is approved, a new branch following the naming convention ~-build~ (e.g., ~poetry-build~, ~pdm-build~) will be created off the default branch. -3. **Submit a Pull Request**: Fork the repository, implement your changes in the +3. *Submit a Pull Request*: Fork the repository, implement your changes in the corresponding branch, and then submit a pull request targeting the newly created branch for the build system.