Skip to content

Commit 2effb3d

Browse files
Fix README formatting and remove GitLab template content
- Remove unclosed code block that broke markdown rendering - Remove GitLab default template content - Add proper bash code block for setup instructions - Clean up heading and title formatting Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 068211b commit 2effb3d

1 file changed

Lines changed: 8 additions & 18 deletions

File tree

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,4 @@
1-
# comcheckweb-api-python
2-
3-
## Getting started
4-
5-
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
6-
7-
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
8-
9-
## Add your files
10-
11-
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
12-
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
13-
14-
```
15-
cd existing_repo
16-
git remote add origin https://gitlab.pnnl.gov/becp/checktool-libraries/comcheckweb-api-python.git
17-
# COMcheckWeb API — Python package
1+
# COMcheckWeb API — Python Package
182

193
This repository contains the COMcheckWeb API Python package. It provides tools and scripts for working with the COMcheckWeb API and is intended to be used as a Python package maintained with `uv` for package management.
204

@@ -28,10 +12,16 @@ Quickly useful notes:
2812
- If you reference this package from other workspace packages, keep the `tool.uv.sources` entry that maps `comcheckweb-api-python = { workspace = true }` so `uv` resolves it to the local workspace copy.
2913
- For a single-package repo you can also rely on `members = ["."]` and omit additional sources, but leaving the explicit source entry is harmless and makes intent clear.
3014

31-
## Getting started
15+
## Getting Started
3216

3317
Clone the repository and follow the commands below to set up developer tooling.
3418

19+
```bash
20+
git clone https://gitlab.pnnl.gov/becp/checktool-libraries/comcheckweb-api-python.git
21+
cd comcheckweb-api-python
22+
uv sync
23+
```
24+
3525
## Common commands
3626

3727
- Setup pre-commit (run once after cloning):

0 commit comments

Comments
 (0)