JOJ/JOJ3-config-generator
27
1
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: README #23

Open
李衍志523370910113 wants to merge 3 commits from docs/README into master
pull from: docs/README
merge into: JOJ:master
Conversation 2 Commits 3 Files Changed 1 +55 -11
1 changed files with 55 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -1,8 +1,12 @@
# JOJ3-config-generator
# JOJ3-forge
张泊明518370910136 commented 2025-06-11 22:37:44 +08:00
Review
Copy Link

We should change this name after changing repo name.

We should change this name after changing repo name.
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a98f9aa020874a93bc791a7616fccf21)](https://app.codacy.com/gh/joint-online-judge/JOJ3-config-generator/dashboard)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/a98f9aa020874a93bc791a7616fccf21)](https://app.codacy.com/gh/joint-online-judge/JOJ3-config-generator/dashboard)
## Introduction
JOJ3-forge is a CLI tool that generates configuration files for [JOJ3](https://github.com/joint-online-judge/JOJ3).
张泊明518370910136 commented 2025-06-11 22:39:33 +08:00
Outdated
Review
Copy Link

I think we should use JOJ3-config-generator here without "`".

I think we should use JOJ3-config-generator here without "`".
## Getting Started
### For users
@ -10,7 +14,7 @@
1. Install [Python>=3.9](https://www.python.org/) and [pip](https://pip.pypa.io/)
2. (Optional) Create a virtual environment, check [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).
3. Install/Upgrade the project by `pip install --force-reinstall --upgrade git+ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git`
4. Run it by `joj3-config-generator --help`
4. Run it by `joj3-forge --help`
### For developers
@ -23,22 +27,62 @@
## How to use?
- `joj3-config-generator convert` function is now supported, currently support one argument as input, it indicates the **convert root**
- default value on the server can be given as `/home/tt/.config/joj`
Run `joj3-forge --help` to get basic CLI usage information.
### `convert`
- `joj3-forge convert` function is now supported, currently support one argument as input, it indicates the **convert root*
- default value on the server should be given as `/home/tt/.config/joj`
- **NOTE:** the user should ensure that the ideal `repo.toml` file is in the sub-directory of the **convert root**
- the intended immutable files should be placed at a sub-directory named `immutable_files` at same position as the `repo.toml` file
- a sample directory tree as follows
```shell
$ tree .
.
|- immutable_files
| |-- push.yaml
| |-- release.yaml
|-- repo.toml
$ tree -a
jon-lee marked this conversation as resolved Outdated
张泊明518370910136 commented 2025-06-11 22:38:23 +08:00
Outdated
Review
Copy Link

try tree --charset unicode ., ascii characters are better.

try `tree --charset unicode .`, ascii characters are better.
home
`-- tt
|-- .cache
`-- .config
`-- joj
|-- hidden
| |-- ex1
| | |-- case1.in
| | |-- case1.out
| | |-- conf.json
| | `-- conf.toml
| |-- immutable_files
| | |-- push.yaml
| | `-- release.yaml
| |-- p1
| | |-- case1.in
| | |-- case1.out
| | |-- conf.json
| | `-- conf.toml
| `-- repo.toml
|-- students
| |-- ex1
| | |-- case1.in
| | |-- case1.out
| | |-- conf.json
| | `-- conf.toml
| |-- immutable_files
| | |-- push.yaml
| | `-- release.yaml
| |-- p1
| | |-- case1.in
| | |-- case1.out
| | |-- conf.json
| | `-- conf.toml
| `-- repo.toml
|-- students.csv
`-- tools
|-- .clang-tidy
|-- compile
`-- helper.sh
```
- sample command on the server
```shell
joj3-config-generator convert /home/tt/.config/joj
joj3-forge convert /home/tt/.config/joj
```