Skip to content

Commit 99e279a

Browse files
committed
nits
1 parent e3a6f89 commit 99e279a

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Now, we have made a major upgrade to StarPerf, extending its usability and enric
2121

2222
Compared with StarPerf 1.0, StarPerf 2.0 is fully implemented in Python and no longer depends on any third-party orbit analysis or computation tools. You only need to ensure that **Python 3.10** or above is installed on your system.
2323

24-
## Installation
24+
# Installation
2525

2626
We recommend using [uv](https://github.com/astral-sh/uv), a fast Python package and project manager, to manage dependencies and virtual environments for this project.
2727

28-
**Install uv:**
28+
**(1) Install uv:**
2929

3030
MacOS/Linux:
3131

@@ -44,7 +44,7 @@ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | ie
4444

4545
For more installation options, please refer to [official uv documentation](https://docs.astral.sh/uv/getting-started/installation/).
4646

47-
**Installing Dependencies:**
47+
**(2) Installing Dependencies:**
4848

4949
Once you have cloned the repository, you can install all required dependencies using the following `uv` command:
5050

@@ -53,9 +53,9 @@ cd StarPerf_Simulator/
5353
uv sync
5454
```
5555

56-
This will automatically create a virtual environment and install all necessary libraries to ensure the system runs properly.
56+
This will automatically create a virtual environment and install all necessary libraries.
5757

58-
# StarPerf overview and processing flow
58+
# StarPerf Overview and Processing Flow
5959

6060
You can directly run our simulation example using the following command:
6161

@@ -84,21 +84,21 @@ http-server -p 8081
8484

8585
5. Open the constellation visualization webpage by entering `http://127.0.0.1:8081/<filename>` in your browser. Here, `<filename>` refers to the name of the webpage file generated by our visualization code under `/StarPerf_Simulator/visualization/CesiumApp`.
8686

87-
# Contributors are more than welcome
87+
# Contributors Are More Than Welcome
8888

8989
Wanna to join the construction of "NewSpace" constellations and networks? Awesome! This project follows the [Github contribution work flow.](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/github-flow) Submissions can fork and use a Github pull request to get merged into this code base.
9090

9191
Ways to help are listed as follows.
9292

93-
### Bug reports
93+
### Bug Reports
9494

9595
If you come across a bug in using StarPerf, you are more than welcome to file a bug report to our mail box.
9696

97-
### Contribute more constellation designs
97+
### Contribute More Constellation Designs
9898

9999
As emerging mega-constellations are still evolving rapidly and constellations such as Starlink and OneWeb are still under heavy development, we welcome all who are interested in this research topic to contribute their innovative designs, documents, insights, comments and suggestions.
100100

101-
### Write test cases
101+
### Write Test Cases
102102

103103
Currently this project has not be ''thoroughly''' tested. You are more than welcome to build any test cases for this project.
104104

0 commit comments

Comments
 (0)