Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation tracker #78

Open
6 of 17 tasks
mfornet opened this issue May 16, 2020 · 1 comment
Open
6 of 17 tasks

Documentation tracker #78

mfornet opened this issue May 16, 2020 · 1 comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@mfornet
Copy link
Owner

mfornet commented May 16, 2020

Currently wiki has only basic setup, but the extension have grown and it is necessary to document all features. This issue will help keep track about everything that needs to be added to the documentation.

Wiki: https://github.com/mfornet/acmx/wiki

  • Home
  • Custom Checker
    Explain how to set up a custom checker for a problem
  • Debug Test Case
    Steps to debug a solution on different languages.
    • C++
    • Python
    • Java
    • Rust
  • FAQ
    • Multiple test case. How to add snippets to read multiple test cases. Builtin feature from vscode, not related to acmx.
    • Read and write from file. Use snippets to add relevant code, and compilation flags to simulate one behavior locally, and different behavior in the online judge.
    • Multiple solution. How to have multiple solution in the same workspace. After Option to select solutions with right click. #73
    • Smart copy. How to use smart copy to generate solutions that use custom library.
  • File Structure
    Explain the structure of all folder and files created and relevant configurations to change it.
    • Location of contest + problems
    • Structure of a single problem (testcase, attic, config.json)
    • Location of languages folder
    • Location of templates
  • Manage Test Cases
    How to create, remove and open a testcase.
  • Multiple Languages
    Explain about language folder and how to modify or create a new language profile.
  • Settings and Commands
    Enumerate all settings and commands exposed by acmx and explain its function. Link to relevant documentation.
  • Stress
    How to stress a solution against a generator and a brute force.
@mfornet mfornet added help wanted Extra attention is needed good first issue Good for newcomers labels May 16, 2020
@mfornet
Copy link
Owner Author

mfornet commented May 16, 2020

@mfornet mfornet added this to the 0.4.0 milestone May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant