JOJ/JOJ3-config-generator
27
1
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
2a6428feec
JOJ3-config-generator/README.md
李衍志523370910113 2a6428feec
All checks were successful
build / build (push) Successful in 2m38s
Details
build / trigger-build-image (push) Has been skipped
Details
build / build (pull_request) Successful in 2m10s
Details
build / trigger-build-image (pull_request) Has been skipped
Details
docs: README
2025-06-11 22:33:15 +08:00

3.0 KiB
Raw Blame History

JOJ3-forge

Codacy Badge Codacy Badge

Introduction

JOJ3-forge is a CLI tool that generates configuration files for JOJ3.

Getting Started

For users

  1. Install Python>=3.9 and pip
  2. (Optional) Create a virtual environment, check here.
  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-forge --help

For developers

  1. Clone this repo by git clone ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  2. Install Python>=3.9 and PDM
  3. Change dir to the repo, cd JOJ3-config-generator
  4. Install deps by pdm install && pdm run pre-commit install
  5. Run the cli app by pdm run app --help
  6. Check other commands or scripts with pdm run --list

How to use?

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
$ tree .
.
├── hidden
│   ├── repo.toml
│   ├── immutable_files
│   │   ├── push.yaml
│   │   └── release.yaml
│   ├── ex1
│   │   ├── caseX.in
│   │   ├── caseX.out
│   │   ├── conf.json
│   │   └── conf.toml
│   └── p1
│       ├── caseX.in
│       ├── caseX.out
│       ├── conf.json
│       └── conf.toml
├── students
│   ├── repo.toml
│   ├── immutable_files
│   │   ├── push.yaml
│   │   └── release.yaml
│   ├── ex1
│   │   ├── caseX.in
│   │   ├── caseX.out
│   │   ├── conf.json
│   │   └── conf.toml
│   └── p1
│       ├── caseX.in
│       ├── caseX.out
│       ├── conf.json
│       └── conf.toml
├── students.csv
└── tools
    ├── .clang-tidy
    └── compile
  • sample command on the server
joj3-forge convert /home/tt/.config/joj