Skip to content

Commit a2d30aa

Browse files
committed
doc: relocate developer notes
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent b989e46 commit a2d30aa

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

README.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -121,40 +121,6 @@ Riccardo Magliocchetti, which combined the original bootchart shell script
121121
by Ziga Mahkovec with pybootchartgui by Anders Norgaard and Henning Niss,
122122
and a C-based collector by Scott James Remnant and Michael Meeks.
123123

124-
## Developer Notes
125-
126-
### Building for PyPI
127-
128-
Generate Python files and build distribution packages:
129-
130-
```bash
131-
make pypi-build
132-
```
133-
134-
### Testing Locally
135-
136-
Test the built package:
137-
138-
```bash
139-
make pypi-test
140-
```
141-
142-
### Publishing
143-
144-
Upload to TestPyPI first (recommended):
145-
146-
```bash
147-
make pypi-upload-test
148-
```
149-
150-
Then publish to PyPI:
151-
152-
```bash
153-
make pypi-upload
154-
```
155-
156-
For detailed PyPI instructions, see [README.PyPI.md](doc/README.PyPI.md).
157-
158124
## License
159125

160126
The visualization tool (initviz.py) is licensed under GPLv3+. The collector

doc/README.PyPI.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,40 @@
22

33
This document describes how to build and publish InitViz to PyPI.
44

5+
## TL;DR
6+
7+
Generate Python files and build distribution packages:
8+
9+
```bash
10+
make pypi-build
11+
```
12+
13+
### Testing Locally
14+
15+
Test the built package:
16+
17+
```bash
18+
make pypi-test
19+
```
20+
21+
### Publishing
22+
23+
Upload to TestPyPI first (recommended):
24+
25+
```bash
26+
make pypi-upload-test
27+
```
28+
29+
Then publish to PyPI:
30+
31+
```bash
32+
make pypi-upload
33+
```
34+
35+
For detailed PyPI instructions, see below.
36+
37+
---
38+
539
## Prerequisites
640

741
Install build tools:

0 commit comments

Comments
 (0)