Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 97f6ded

Browse files
committedMar 4, 2025·
docs: update the readmes
1 parent 1845eaa commit 97f6ded

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed
 

‎ABOUT_THIS_TEMPLATE.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Hi, I've adapted this template from the excellent [python-project-template](http
44

55
It includes:
66

7-
- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project.
8-
Template uses setuptools because it's the de-facto standard for Python packages
9-
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org)
10-
- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/)
11-
- ✅ Code linting using [pylint](https://pypi.org/project/pylint/)
12-
- 🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing.
13-
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project.
7+
- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project;
8+
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org);
9+
- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/);
10+
- ✅ Code linting using [pylint](https://pypi.org/project/pylint/);
11+
- 🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing;
12+
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project;
13+
- 🌐 An out-of-the-box project page created automatically for your project.
1414

1515
Are there any changes you'd like to request? Feel free to fork and open a pull request!
1616

@@ -28,6 +28,7 @@ Lets take a look at the structure of this template:
2828
│ requirements-dev.txt # List of requirements for testing and devlopment
2929
│ requirements.txt # An empty file to hold the requirements for the project
3030
│ setup.py # The setup.py file for installing and packaging the project
31+
│ index.html # The template page for the automatically generated project page
3132
3233
├───.github # Github metadata for repository
3334
│ │ dependabot.yml # Dependabot workflow for updating requirements
@@ -46,6 +47,8 @@ Lets take a look at the structure of this template:
4647
├───docs # Auto-generated documentation
4748
│ index.md # Landing page of docs
4849
50+
├───static # Images & CSS files to generate the project page
51+
4952
├───ukp_project_template # The main python package for the project
5053
│ base.py # The base module for the project
5154
│ cli.py # Defines CLI instructions
@@ -60,6 +63,9 @@ Lets take a look at the structure of this template:
6063

6164
## FAQs
6265

66+
### How do I adapt the website to my needs ?
67+
68+
You should change the content of `index.html` to fit your needs. Some tinkering with the CSS inside `static` may be required.
6369

6470
### Where should I add new stuff ?
6571

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ If you want to set up this template:
3333
3. Delete optional files:
3434
- If you don't need automatic documentation generation, you can delete folder `docs`, file `.github\workflows\docs.yml` and `mkdocs.yml`
3535
- If you don't want automatic testing, you can delete folder `tests` and file `.github\workflows\tests.yml`
36+
- If you do not wish to have a project page, delete folder `static` and files `.nojekyll`, `index.html`
3637
4. Prepare a virtual environment:
3738
```bash
3839
python -m venv .venv

0 commit comments

Comments
 (0)
Please sign in to comment.