Skip to content

Commit

Permalink
Rename every Readme.md to README.md
Browse files Browse the repository at this point in the history
Otherwise `cargo package --list --allow-dirty` outputs both `README.md` and `Readme.md`

```
Cargo.toml
Cargo.toml.orig
LICENSE
README.md
Readme.md
check_installed/check_installed.py
pyo3_pure.pyi
pyproject.toml
src/lib.rs
tests/test_pyo3_pure.py
tox.ini
```
  • Loading branch information
messense committed Oct 30, 2022
1 parent ae9acb9 commit 6037298
Show file tree
Hide file tree
Showing 20 changed files with 17 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ version = "0.14.0-beta.3"
description = "Build and publish crates with pyo3, rust-cpython and cffi bindings as well as rust binaries as python packages"
exclude = ["test-crates/**/*", "sysconfig/*", "test-data/*", "ci/*", "tests/*", "guide/*", ".github/*"]
homepage = "https://github.com/pyo3/maturin"
readme = "Readme.md"
readme = "README.md"
repository = "https://github.com/pyo3/maturin"
license = "MIT OR Apache-2.0"
keywords = ["python", "cffi", "packaging", "pypi", "pyo3"]
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
include Cargo.toml Cargo.lock
include Readme.md
include README.md
include license-apache license-mit
recursive-include src *.rs *.py
recursive-include src/auditwheel *.json
Expand Down
6 changes: 3 additions & 3 deletions Readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ my-project
│   ├── __init__.py
│   └── bar.py
├── pyproject.toml
├── Readme.md
├── README.md
└── src
   └── lib.rs
```
Expand Down Expand Up @@ -135,7 +135,7 @@ my-project
│ ├── __init__.py
│ └── bar.py
├── pyproject.toml
├── Readme.md
├── README.md
└── src
   └── lib.rs
```
Expand All @@ -156,7 +156,7 @@ my-project
│   ├── __init__.py
│   ├── bar.py
│   └── my_project.cpython-36m-x86_64-linux-gnu.so
├── Readme.md
├── README.md
└── src
   └── lib.rs
```
Expand Down
2 changes: 1 addition & 1 deletion ci/build_deb.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ install -Dm755 "target/$TARGET/release/$BINARY_NAME" "$tempdir/usr/bin/$BINARY_N
strip "$tempdir/usr/bin/$BINARY_NAME"

# readme and license
install -Dm644 Readme.md "$tempdir/usr/share/doc/$BINARY_NAME/Readme.md"
install -Dm644 README.md "$tempdir/usr/share/doc/$BINARY_NAME/README.md"
install -Dm644 license-mit "$tempdir/usr/share/doc/$BINARY_NAME/license-mit"
install -Dm644 license-apache "$tempdir/usr/share/doc/$BINARY_NAME/license-apache"

Expand Down
2 changes: 1 addition & 1 deletion guide/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Welcome to the maturin user guide! It contains examples and documentation to exp

Please choose from the chapters on the left to jump to individual topics, or continue below to start with maturin's README.

{{#include ../../Readme.md}}
{{#include ../../README.md}}
2 changes: 1 addition & 1 deletion guide/src/project_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ my-rust-and-python-project
│ ├── __init__.py
│ └── bar.py
├── pyproject.toml
├── Readme.md
├── README.md
└── src
└── lib.rs
```
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def finalize_options(self):
except ImportError:
bdist_wheel = None

with open("Readme.md", encoding="utf-8", errors="ignore") as fp:
with open("README.md", encoding="utf-8", errors="ignore") as fp:
long_description = fp.read()

with open("Cargo.toml", "rb") as fp:
Expand Down
2 changes: 1 addition & 1 deletion src/metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ mod test {
);
assert_eq!(
metadata.description,
Some(fs_err::read_to_string("test-crates/pyo3-pure/Readme.md").unwrap())
Some(fs_err::read_to_string("test-crates/pyo3-pure/README.md").unwrap())
);
assert_eq!(metadata.classifiers, &["Programming Language :: Rust"]);
assert_eq!(
Expand Down
2 changes: 1 addition & 1 deletion src/project_layout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ impl ProjectResolver {
// Detect src layout:
//
// my-project
// ├── Readme.md
// ├── README.md
// ├── pyproject.toml
// ├── src
// │ └── my_project
Expand Down
2 changes: 1 addition & 1 deletion test-crates/hello-world/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.1.0"
authors = ["konstin <konstin@mailbox.org>"]
edition = "2018"
# Test references to out-of-project files
readme = "../../Readme.md"
readme = "../../README.md"
default-run = "hello-world"

[dependencies]
File renamed without changes.
2 changes: 1 addition & 1 deletion test-crates/pyo3-ffi-pure/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ classifiers = [
"Programming Language :: Rust"
]
description = "Tests compilation of packages using pyo3-ffi bindings"
readme = "Readme.md"
readme = "README.md"
maintainers = [
{name = "messense", email = "messense@icloud.com"}
]
Expand Down
2 changes: 1 addition & 1 deletion test-crates/pyo3-mixed-py-subdir/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["konstin <konstin@mailbox.org>"]
name = "pyo3-mixed-py-subdir"
version = "2.1.3"
description = "Implements a dummy function combining rust and python"
readme = "Readme.md"
readme = "README.md"
edition = "2018"

[dependencies]
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion test-crates/pyo3-mixed-submodule/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["konstin <konstin@mailbox.org>"]
name = "pyo3-mixed-submodule"
version = "2.1.3"
description = "Implements a dummy function combining rust and python"
readme = "Readme.md"
readme = "README.md"
edition = "2018"

[package.metadata.maturin]
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion test-crates/pyo3-pure/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ classifiers = [
"Programming Language :: Rust"
]
description = "Implements a dummy function in Rust"
readme = "Readme.md"
readme = "README.md"
maintainers = [
{name = "messense", email = "messense@icloud.com"}
]
Expand Down
2 changes: 1 addition & 1 deletion test-crates/update_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@


FILES = [
"Readme.md",
"README.md",
"guide/src/develop.md",
"guide/src/tutorial.md",
"guide/src/distribution.md",
Expand Down
1 change: 0 additions & 1 deletion tests/run.rs
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,6 @@ fn workspace_members_non_local_dep_sdist() {
"pyo3_pure-0.1.0+abc123de/LICENSE",
"pyo3_pure-0.1.0+abc123de/PKG-INFO",
"pyo3_pure-0.1.0+abc123de/README.md",
"pyo3_pure-0.1.0+abc123de/Readme.md",
"pyo3_pure-0.1.0+abc123de/check_installed/check_installed.py",
"pyo3_pure-0.1.0+abc123de/pyo3_pure.pyi",
"pyo3_pure-0.1.0+abc123de/pyproject.toml",
Expand Down

0 comments on commit 6037298

Please sign in to comment.